gain.grr package

Module contents

The public import path for scripts and notebooks that use a GRR.

gain.grr re-exports, under one short path, the constructors of a Genomic Resource Repository, the functions that build a resource object from a resource or a resource id, and the GAIn types those functions accept and return, except GenomicContext, which stays in gain.genomic_resources.genomic_context:

import gain.grr as grr

repo = grr.build_genomic_resource_repository()
genome = grr.build_reference_genome_from_resource_id(
    "hg38/genomes/GRCh38-hg38", repo)

Every name here is the same object as in the module that defines it, and the names in __all__ are the supported surface: removing one takes a release with a deprecation warning first. The defining modules stay importable and supported. Code inside gain imports from the defining modules, never from here.

Annotation pipelines are not part of this surface; they are built from gain.annotation.annotation_factory. See ADR 0033 for what is in scope and why.