Skill Tracer
Skills › Scientific Agent Skills › gget › module_catalog.md

module_catalog.md

767 lines · skills/gget/references/module_catalog.md at 5f2bc03

Open on GitHub
1# gget Module Catalog
2
3Every module by category, with selected parameters and CLI/Python examples for gget 0.30.8. Examples are illustrative unless identified as executed in [workflows.md](workflows.md); optional setup, input files, and network access are required. See [database contracts](database_info.md) for authentication, return fields, and pagination limits.
4This is the usage-oriented cut; see `module_reference.md` for the fuller per-parameter
5reference and `database_info.md` for the underlying data sources.
6

gget Module Catalog

Every module by category, with selected parameters and CLI/Python examples for gget 0.30.8. Examples are illustrative unless identified as executed in workflows.md; optional setup, input files, and network access are required. See database contracts for authentication, return fields, and pagination limits. This is the usage-oriented cut; see module_reference.md for the fuller per-parameter reference and database_info.md for the underlying data sources.

Raw lines 1 to 6
7## Module Categories
8

Module Categories

Raw lines 7 to 8
9### 1. Reference & Gene Information
11#### gget ref - Reference Genome Downloads
13Retrieve download links and metadata for Ensembl reference genomes.
15**Parameters**:
16- `species`: Genus_species format (e.g., 'homo_sapiens', 'mus_musculus'). Shortcuts: 'human', 'mouse'
17- `-w/--which`: Specify return types as comma-separated CLI values or Python list (gtf, cdna, dna, cds, cdrna, pep). Default: all
18- `-r/--release`: Ensembl release number (default: latest)
19- `-od/--out_dir`: Directory for downloaded files
20- `-l/--list_species`: List available vertebrate species
21- `-liv/--list_iv_species`: List available invertebrate species
22- `-ftp`: Return only FTP links
23- `-d/--download`: CLI-only download (requires curl; Python returns links)
25**Examples**:
26```bash
27# List available species
28gget ref --list_species
30# Get all reference files for human
31gget ref homo_sapiens
33# Download GTF and cDNA files for mouse
34gget ref -w gtf,cdna -d mouse
35```
37```python
38# Python
39gget.ref("homo_sapiens")
40gget.ref("mus_musculus", which=["gtf", "cdna"]) # metadata/links; CLI -d downloads
41```
43#### gget search - Gene Search
45Locate genes by name, description, and Ensembl synonyms across species.
47**Parameters**:
48- `searchwords`: One or more search terms (case-insensitive)
49- `-s/--species`: Target species (e.g., 'homo_sapiens', 'mouse')
50- `-r/--release`: Ensembl release number
51- `-t/--id_type`: Return 'gene' (default) or 'transcript'
52- `-ao/--andor`: 'or' (default) finds ANY searchword; 'and' requires ALL
53- `-l/--limit`: Maximum results to return
54- `wrap_text`: Python-only display helper for wide DataFrames
56**Returns**: ensembl_id, gene_name, ensembl_description, ext_ref_description, biotype, synonym, url
58**Examples**:
59```bash
60# Search for GABA-related genes in human
61gget search -s human gaba gamma-aminobutyric
63# Find specific gene, require all terms
64gget search -s mouse -ao and pax7 transcription
65```
67```python
68# Python
69gget.search(["gaba", "gamma-aminobutyric"], species="homo_sapiens")
70```
72#### gget info - Gene/Transcript Information
74Retrieve comprehensive gene and transcript metadata from Ensembl, UniProt, and NCBI.
76**Parameters**:
77- `ens_ids`: One or more Ensembl IDs (also supports WormBase, Flybase IDs). Limit: ~1000 IDs
78- `-n/--ncbi`: Disable NCBI data retrieval
79- `-u/--uniprot`: Disable UniProt data retrieval
80- `-pdb`: Include PDB identifiers (increases runtime)
82**Returns**: UniProt ID, NCBI gene ID, primary gene name, synonyms, protein names, descriptions, biotype, canonical transcript
84**Examples**:
85```bash
86# Get info for multiple genes
87gget info ENSG00000034713 ENSG00000104853 ENSG00000170296
89# Include PDB IDs
90gget info ENSG00000034713 -pdb
91```
93```python
94# Python
95gget.info(["ENSG00000034713", "ENSG00000104853"], pdb=True)
96```
98#### gget seq - Sequence Retrieval
100Fetch nucleotide or amino acid sequences for genes and transcripts.
102**Parameters**:
103- `ens_ids`: One or more Ensembl identifiers
104- `-t/--translate`: Fetch amino acid sequences instead of nucleotide
105- `-iso/--isoforms`: Return all transcript variants (gene IDs only)
107**Returns**: Python list of FASTA lines (header, sequence, ...), or None on failure; CLI prints FASTA
109**Examples**:
110```bash
111# Get nucleotide sequences
112gget seq ENSG00000034713 ENSG00000104853
114# Get all protein isoforms
115gget seq -t -iso ENSG00000034713
116```
118```python
119# Python
120gget.seq(["ENSG00000034713"], translate=True, isoforms=True)
121```

1. Reference & Gene Information

gget ref - Reference Genome Downloads

Retrieve download links and metadata for Ensembl reference genomes.

Parameters:

  • species: Genus_species format (e.g., 'homo_sapiens', 'mus_musculus'). Shortcuts: 'human', 'mouse'
  • -w/--which: Specify return types as comma-separated CLI values or Python list (gtf, cdna, dna, cds, cdrna, pep). Default: all
  • -r/--release: Ensembl release number (default: latest)
  • -od/--out_dir: Directory for downloaded files
  • -l/--list_species: List available vertebrate species
  • -liv/--list_iv_species: List available invertebrate species
  • -ftp: Return only FTP links
  • -d/--download: CLI-only download (requires curl; Python returns links)

Examples:

# List available species
gget ref --list_species

# Get all reference files for human
gget ref homo_sapiens

# Download GTF and cDNA files for mouse
gget ref -w gtf,cdna -d mouse
# Python
gget.ref("homo_sapiens")
gget.ref("mus_musculus", which=["gtf", "cdna"])  # metadata/links; CLI -d downloads

gget search - Gene Search

Locate genes by name, description, and Ensembl synonyms across species.

Parameters:

  • searchwords: One or more search terms (case-insensitive)
  • -s/--species: Target species (e.g., 'homo_sapiens', 'mouse')
  • -r/--release: Ensembl release number
  • -t/--id_type: Return 'gene' (default) or 'transcript'
  • -ao/--andor: 'or' (default) finds ANY searchword; 'and' requires ALL
  • -l/--limit: Maximum results to return
  • wrap_text: Python-only display helper for wide DataFrames

Returns: ensembl_id, gene_name, ensembl_description, ext_ref_description, biotype, synonym, url

Examples:

# Search for GABA-related genes in human
gget search -s human gaba gamma-aminobutyric

# Find specific gene, require all terms
gget search -s mouse -ao and pax7 transcription
# Python
gget.search(["gaba", "gamma-aminobutyric"], species="homo_sapiens")

gget info - Gene/Transcript Information

Retrieve comprehensive gene and transcript metadata from Ensembl, UniProt, and NCBI.

Parameters:

  • ens_ids: One or more Ensembl IDs (also supports WormBase, Flybase IDs). Limit: ~1000 IDs
  • -n/--ncbi: Disable NCBI data retrieval
  • -u/--uniprot: Disable UniProt data retrieval
  • -pdb: Include PDB identifiers (increases runtime)

Returns: UniProt ID, NCBI gene ID, primary gene name, synonyms, protein names, descriptions, biotype, canonical transcript

Examples:

# Get info for multiple genes
gget info ENSG00000034713 ENSG00000104853 ENSG00000170296

# Include PDB IDs
gget info ENSG00000034713 -pdb
# Python
gget.info(["ENSG00000034713", "ENSG00000104853"], pdb=True)

gget seq - Sequence Retrieval

Fetch nucleotide or amino acid sequences for genes and transcripts.

Parameters:

  • ens_ids: One or more Ensembl identifiers
  • -t/--translate: Fetch amino acid sequences instead of nucleotide
  • -iso/--isoforms: Return all transcript variants (gene IDs only)

Returns: Python list of FASTA lines (header, sequence, ...), or None on failure; CLI prints FASTA

Examples:

# Get nucleotide sequences
gget seq ENSG00000034713 ENSG00000104853

# Get all protein isoforms
gget seq -t -iso ENSG00000034713
# Python
gget.seq(["ENSG00000034713"], translate=True, isoforms=True)
Raw lines 9 to 122
123### 2. Sequence Analysis & Alignment
125#### gget blast - BLAST Searches
127BLAST nucleotide or amino acid sequences against standard databases.
129**Parameters**:
130- `sequence`: Sequence string or path to FASTA/.txt file
131- `-p/--program`: blastn, blastp, blastx, tblastn, tblastx (auto-detected)
132- `-db/--database`:
133 - Nucleotide: nt, refseq_rna, pdbnt
134 - Protein: nr, swissprot, pdbaa, refseq_protein
135- `-l/--limit`: Max hits (default: 50)
136- `-e/--expect`: E-value cutoff (default: 10.0)
137- `-lcf/--low_comp_filt`: Enable low complexity filtering
138- `-mbo/--megablast_off`: Disable MegaBLAST (blastn only)
140**Examples**:
141```bash
142# BLAST protein sequence
143gget blast MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
145# BLAST from file with specific database
146gget blast sequence.fasta -db swissprot -l 10
147```
149```python
150# Python
151gget.blast("MKWMFK...", database="swissprot", limit=10)
152```
154#### gget blat - BLAT Searches
156Locate genomic positions of sequences using UCSC BLAT.
158**Parameters**:
159- `sequence`: Sequence string or path to FASTA/.txt file
160- `-st/--seqtype`: 'DNA', 'protein', 'translated%20RNA', 'translated%20DNA' (auto-detected)
161- `-a/--assembly`: Target assembly (default: 'human'/hg38; options: 'mouse'/mm39, 'zebrafinch'/taeGut2, etc.)
163**Returns**: genome, query size, alignment positions, matches, mismatches, alignment percentage
165**Examples**:
166```bash
167# Find genomic location in human
168gget blat ATCGATCGATCGATCG
170# Search in different assembly
171gget blat -a mm39 ATCGATCGATCGATCG
172```
174```python
175# Python
176gget.blat("ATCGATCGATCGATCG", assembly="mouse")
177```
179#### gget muscle - Multiple Sequence Alignment
181Align multiple nucleotide or amino acid sequences using Muscle5.
183**Parameters**:
184- `fasta`: Sequences or path to FASTA/.txt file
185- `-s5/--super5`: Use Super5 algorithm for faster processing (large datasets)
187**Returns**: Aligned sequences in ClustalW format or aligned FASTA (.afa)
189**Examples**:
190```bash
191# Align sequences from file
192gget muscle sequences.fasta -o aligned.afa
194# Use Super5 for large dataset
195gget muscle large_dataset.fasta -s5
196```
198```python
199# Python
200gget.muscle("sequences.fasta", out="aligned.afa")
201```
203#### gget diamond - Local Sequence Alignment
205Perform fast local protein alignment or translated nucleotide-to-protein alignment using DIAMOND.
207**Parameters**:
208- Query: Sequences (string/list) or FASTA file path
209- `-ref/--reference`: Reference sequences (string/list) or FASTA file path (required)
210- `-s/--sensitivity`: fast, mid-sensitive, sensitive, more-sensitive, very-sensitive (default), ultra-sensitive
211- `-t/--threads`: CPU threads (default: 1)
212- `-db/--diamond_db`: Database output path (reference still required)
213- `-x/--translated`: Enable nucleotide query to amino acid reference alignment
215**Returns**: Identity percentage, sequence lengths, match positions, gap openings, E-values, bit scores
217**Examples**:
218```bash
219# Align against reference
220gget diamond GGETISAWESQME -ref reference.fasta -t 4
222# Translate nucleotide query against amino acid reference
223gget diamond query_nt.fasta -ref proteins.fasta --translated
224```
226```python
227# Python
228gget.diamond("GGETISAWESQME", reference="reference.fasta", threads=4)
229gget.diamond("ATGGGC...", reference="proteins.fasta", translated=True)
230```

2. Sequence Analysis & Alignment

gget blast - BLAST Searches

BLAST nucleotide or amino acid sequences against standard databases.

Parameters:

  • sequence: Sequence string or path to FASTA/.txt file
  • -p/--program: blastn, blastp, blastx, tblastn, tblastx (auto-detected)
  • -db/--database:
  • Nucleotide: nt, refseq_rna, pdbnt
  • Protein: nr, swissprot, pdbaa, refseq_protein
  • -l/--limit: Max hits (default: 50)
  • -e/--expect: E-value cutoff (default: 10.0)
  • -lcf/--low_comp_filt: Enable low complexity filtering
  • -mbo/--megablast_off: Disable MegaBLAST (blastn only)

Examples:

# BLAST protein sequence
gget blast MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR

# BLAST from file with specific database
gget blast sequence.fasta -db swissprot -l 10
# Python
gget.blast("MKWMFK...", database="swissprot", limit=10)

gget blat - BLAT Searches

Locate genomic positions of sequences using UCSC BLAT.

Parameters:

  • sequence: Sequence string or path to FASTA/.txt file
  • -st/--seqtype: 'DNA', 'protein', 'translated%20RNA', 'translated%20DNA' (auto-detected)
  • -a/--assembly: Target assembly (default: 'human'/hg38; options: 'mouse'/mm39, 'zebrafinch'/taeGut2, etc.)

Returns: genome, query size, alignment positions, matches, mismatches, alignment percentage

Examples:

# Find genomic location in human
gget blat ATCGATCGATCGATCG

# Search in different assembly
gget blat -a mm39 ATCGATCGATCGATCG
# Python
gget.blat("ATCGATCGATCGATCG", assembly="mouse")

gget muscle - Multiple Sequence Alignment

Align multiple nucleotide or amino acid sequences using Muscle5.

Parameters:

  • fasta: Sequences or path to FASTA/.txt file
  • -s5/--super5: Use Super5 algorithm for faster processing (large datasets)

Returns: Aligned sequences in ClustalW format or aligned FASTA (.afa)

Examples:

# Align sequences from file
gget muscle sequences.fasta -o aligned.afa

# Use Super5 for large dataset
gget muscle large_dataset.fasta -s5
# Python
gget.muscle("sequences.fasta", out="aligned.afa")

gget diamond - Local Sequence Alignment

Perform fast local protein alignment or translated nucleotide-to-protein alignment using DIAMOND.

Parameters:

  • Query: Sequences (string/list) or FASTA file path
  • -ref/--reference: Reference sequences (string/list) or FASTA file path (required)
  • -s/--sensitivity: fast, mid-sensitive, sensitive, more-sensitive, very-sensitive (default), ultra-sensitive
  • -t/--threads: CPU threads (default: 1)
  • -db/--diamond_db: Database output path (reference still required)
  • -x/--translated: Enable nucleotide query to amino acid reference alignment

Returns: Identity percentage, sequence lengths, match positions, gap openings, E-values, bit scores

Examples:

# Align against reference
gget diamond GGETISAWESQME -ref reference.fasta -t 4

# Translate nucleotide query against amino acid reference
gget diamond query_nt.fasta -ref proteins.fasta --translated
# Python
gget.diamond("GGETISAWESQME", reference="reference.fasta", threads=4)
gget.diamond("ATGGGC...", reference="proteins.fasta", translated=True)
Raw lines 123 to 231
232### 3. Structural & Protein Analysis
234#### gget pdb - Protein Structures
236Query RCSB Protein Data Bank for structure and metadata.
238**Parameters**:
239- `pdb_id`: PDB identifier (e.g., '7S7U')
240- `-r/--resource`: Data type (pdb, mmcif, entry, pubmed, assembly, entity types)
241- `-i/--identifier`: Assembly, entity, or chain ID
243**Returns**: PDB/mmCIF text (structures) or dictionary (metadata); `resource="pdb"` falls back to mmCIF if PDB is unavailable
245**Examples**:
246```bash
247# Download PDB structure
248gget pdb 7S7U -o 7S7U.pdb
250# Get metadata
251gget pdb 7S7U -r entry
252```
254```python
255# Python
256gget.pdb("7S7U", save=True)
257```
259#### gget g2p - Residue Annotations and Isoform Maps
261Public G2P lookups, added in 0.30.7 and updated in 0.30.8. At least one of `gene`
262or `uniprot_id` is required. Gene-only lookup chooses a reviewed human UniProt
263match; specify the pair when identity matters. `resource` is `features`, `map`,
264or `alignment`. Alignment requires explicit canonical `uniprot_id` and alternative
265`isoform`. `residues` filters positions locally for features/alignment, not map.
266Python returns DataFrame or None on request failure; invalid inputs can raise.
267There is no Python `json` argument. `out` writes CSV and overrides `save`.
269```bash
270gget g2p TP53 -u P04637 -r map --csv
271```
273```python
274mapping = gget.g2p("TP53", uniprot_id="P04637", resource="map")
275features = gget.g2p("TP53", uniprot_id="P04637", residues=[175, 248, 273])
276```
278Results include `gene_name`/`uniprot_id`; maps add `PDB Ids List`. The public API
279does not expose the portal's ClinVar/gnomAD/HGMD variant overlays. Per-residue
280scores and predictions require their own calibration; they do not establish
281pathogenicity. [Official manual](https://scverse.org/gget/en/g2p.html).
283#### gget alphafold - Protein Structure Prediction
285Legacy AlphaFold2 wrapper, deprecated and no longer actively maintained since 0.30.7. Retained for existing environments; prefer a maintained predictor for new work.
287**Setup Required**:
288```bash
289# Legacy setup; installs third-party dependencies and downloads model parameters
290gget setup alphafold
291```
293**Parameters**:
294- `sequence`: Amino acid sequence (string), multiple sequences (list), or FASTA file. Multiple sequences trigger multimer modeling
295- `-mr/--multimer_recycles`: Recycling iterations (default: 3; higher values increase compute without guaranteeing accuracy)
296- `-mfm/--multimer_for_monomer`: Apply multimer model to single proteins
297- `-r/--relax`: AMBER relaxation for top-ranked model
298- `-jhd/--jackhmmer_savedir`: Directory for temporary jackhmmer files
299- `plot`: Python-only; generate interactive 3D visualization (default: True)
300- `show_sidechains`: Python-only; include side chains (default: True)
302**Returns**: PDB structure file, JSON alignment error data, optional 3D visualization
304**Examples**:
305```bash
306# Predict single protein structure
307gget alphafold MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
309# Legacy multimer example; increased recycles are not an accuracy guarantee
310gget alphafold sequence1.fasta -mr 20 -r
311```
313```python
314# Python with visualization
315gget.alphafold("MKWMFK...", plot=True, show_sidechains=True)
317# Multimer prediction
318gget.alphafold(["sequence1", "sequence2"], multimer_recycles=20)
319```
321#### gget elm - Eukaryotic Linear Motifs
323Predict Eukaryotic Linear Motifs in protein sequences.
325**Setup Required**:
326```bash
327gget setup elm
328```
330**Parameters**:
331- `sequence`: Amino acid sequence or UniProt Acc
332- `-u/--uniprot`: Indicates sequence is UniProt Acc
333- `-e/--expand`: Include protein names, organisms, references
334- `-s/--sensitivity`: DIAMOND alignment sensitivity (default: "very-sensitive")
335- `-t/--threads`: Number of threads (default: 1)
337**Returns**: Two outputs:
3381. **ortholog_df**: Linear motifs from orthologous proteins
3392. **regex_df**: Motifs directly matched in input sequence
341**Examples**:
342```bash
343# Predict motifs from sequence
344gget elm LIAQSIGQASFV -o results
346# Use UniProt accession with expanded info
347gget elm --uniprot Q02410 -e
348```
350```python
351# Python
352ortholog_df, regex_df = gget.elm("LIAQSIGQASFV")
353```

3. Structural & Protein Analysis

gget pdb - Protein Structures

Query RCSB Protein Data Bank for structure and metadata.

Parameters:

  • pdb_id: PDB identifier (e.g., '7S7U')
  • -r/--resource: Data type (pdb, mmcif, entry, pubmed, assembly, entity types)
  • -i/--identifier: Assembly, entity, or chain ID

Returns: PDB/mmCIF text (structures) or dictionary (metadata); resource="pdb" falls back to mmCIF if PDB is unavailable

Examples:

# Download PDB structure
gget pdb 7S7U -o 7S7U.pdb

# Get metadata
gget pdb 7S7U -r entry
# Python
gget.pdb("7S7U", save=True)

gget g2p - Residue Annotations and Isoform Maps

Public G2P lookups, added in 0.30.7 and updated in 0.30.8. At least one of gene or uniprot_id is required. Gene-only lookup chooses a reviewed human UniProt match; specify the pair when identity matters. resource is features, map, or alignment. Alignment requires explicit canonical uniprot_id and alternative isoform. residues filters positions locally for features/alignment, not map. Python returns DataFrame or None on request failure; invalid inputs can raise. There is no Python json argument. out writes CSV and overrides save.

gget g2p TP53 -u P04637 -r map --csv
mapping = gget.g2p("TP53", uniprot_id="P04637", resource="map")
features = gget.g2p("TP53", uniprot_id="P04637", residues=[175, 248, 273])

Results include gene_name/uniprot_id; maps add PDB Ids List. The public API does not expose the portal's ClinVar/gnomAD/HGMD variant overlays. Per-residue scores and predictions require their own calibration; they do not establish pathogenicity. Official manual.

gget alphafold - Protein Structure Prediction

Legacy AlphaFold2 wrapper, deprecated and no longer actively maintained since 0.30.7. Retained for existing environments; prefer a maintained predictor for new work.

Setup Required:

# Legacy setup; installs third-party dependencies and downloads model parameters
gget setup alphafold

Parameters:

  • sequence: Amino acid sequence (string), multiple sequences (list), or FASTA file. Multiple sequences trigger multimer modeling
  • -mr/--multimer_recycles: Recycling iterations (default: 3; higher values increase compute without guaranteeing accuracy)
  • -mfm/--multimer_for_monomer: Apply multimer model to single proteins
  • -r/--relax: AMBER relaxation for top-ranked model
  • -jhd/--jackhmmer_savedir: Directory for temporary jackhmmer files
  • plot: Python-only; generate interactive 3D visualization (default: True)
  • show_sidechains: Python-only; include side chains (default: True)

Returns: PDB structure file, JSON alignment error data, optional 3D visualization

Examples:

# Predict single protein structure
gget alphafold MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR

# Legacy multimer example; increased recycles are not an accuracy guarantee
gget alphafold sequence1.fasta -mr 20 -r
# Python with visualization
gget.alphafold("MKWMFK...", plot=True, show_sidechains=True)

# Multimer prediction
gget.alphafold(["sequence1", "sequence2"], multimer_recycles=20)

gget elm - Eukaryotic Linear Motifs

Predict Eukaryotic Linear Motifs in protein sequences.

Setup Required:

gget setup elm

Parameters:

  • sequence: Amino acid sequence or UniProt Acc
  • -u/--uniprot: Indicates sequence is UniProt Acc
  • -e/--expand: Include protein names, organisms, references
  • -s/--sensitivity: DIAMOND alignment sensitivity (default: "very-sensitive")
  • -t/--threads: Number of threads (default: 1)

Returns: Two outputs:

  1. ortholog_df: Linear motifs from orthologous proteins
  2. regex_df: Motifs directly matched in input sequence

Examples:

# Predict motifs from sequence
gget elm LIAQSIGQASFV -o results

# Use UniProt accession with expanded info
gget elm --uniprot Q02410 -e
# Python
ortholog_df, regex_df = gget.elm("LIAQSIGQASFV")
Raw lines 232 to 354
355### 4. Expression & Disease Data
357#### gget archs4 - Gene Correlation & Tissue Expression
359Query ARCHS4 database for correlated genes or tissue expression data.
361**Parameters**:
362- `gene`: Gene symbol or Ensembl ID (with `--ensembl` flag)
363- `-w/--which`: 'correlation' (default, returns 100 most correlated genes) or 'tissue' (expression atlas)
364- `-s/--species`: 'human' (default) or 'mouse' (tissue data only)
365- `-e/--ensembl`: Input is Ensembl ID
367**Returns**:
368- **Correlation mode**: `gene_symbol`, `pearson_correlation` (human only; Python `gene_count` controls count)
369- **Tissue mode**: `id`, `min`, `q1`, `median`, `q3`, `max`
371**Examples**:
372```bash
373# Get correlated genes
374gget archs4 ACE2
376# Get tissue expression
377gget archs4 -w tissue ACE2
378```
380```python
381# Python
382gget.archs4("ACE2", which="tissue")
383```
385#### gget cellxgene - Single-Cell RNA-seq Data
387Query CZ CELLxGENE Discover Census for single-cell data.
389**Setup Required**:
390```bash
391gget setup cellxgene
392```
394**Parameters**:
395- `--gene` (-g): Gene names or Ensembl IDs (case-sensitive! 'PAX7' for human, 'Pax7' for mouse)
396- `--tissue`: Tissue type(s)
397- `--cell_type`: Specific cell type(s)
398- `--species` (-s): 'homo_sapiens' (default), 'mus_musculus', 'macaca_mulatta', 'callithrix_jacchus', or 'pan_troglodytes' (primates require Census 2025-11-08 or newer)
399- `--census_version` (-cv): Version ("stable", "latest", or dated)
400- `--ensembl` (-e): Use Ensembl IDs
401- `--meta_only` (-mo): Return metadata only
402- Additional filters: disease, development_stage, sex, assay, dataset_id, donor_id, self_reported_ethnicity, suspension_type
404**Returns**: AnnData with raw counts; metadata-only DataFrame rows are cells, and the gene filter is ignored in that mode. Pin a dated release and scope observations.
406**Examples**:
407```bash
408# Get single-cell data for specific genes and cell types
409gget cellxgene --gene ACE2 ABCA1 --tissue lung --cell_type "mucus secreting cell" -o lung_data.h5ad
411# Metadata only
412gget cellxgene --gene PAX7 --tissue muscle --meta_only -o metadata.csv
413```
415```python
416# Python
417adata = gget.cellxgene(gene=["ACE2", "ABCA1"], tissue="lung", cell_type="mucus secreting cell")
418```
420#### gget enrichr - Enrichment Analysis
422Perform ontology enrichment analysis on gene lists using Enrichr.
424**Parameters**:
425- `genes`: Gene symbols, or Ensembl IDs with `ensembl=True` / CLI `--ensembl`
426- `-db/--database`: Reference database (supports shortcuts: 'pathway', 'transcription', 'ontology', 'diseases_drugs', 'celltypes')
427- `-s/--species`: human (default), mouse, fly, yeast, worm, fish
428- `-bkg_l/--background_list`: Background genes for comparison
429- `-ko/--kegg_out`: Save KEGG pathway images with highlighted genes
430- `plot`: Python-only; generate graphical results
432**Database Shortcuts**:
433- 'pathway' → KEGG_2021_Human
434- 'transcription' → ChEA_2016
435- 'ontology' → GO_Biological_Process_2021
436- 'diseases_drugs' → GWAS_Catalog_2019
437- 'celltypes' → PanglaoDB_Augmented_2021
438- 'kinase_interactions' → KEA_2015
440Shortcuts apply to human/mouse only. Other species need their full library names; custom backgrounds are human/mouse only. Ensembl background IDs also require `ensembl_bkg=True`.
442**Examples**:
443```bash
444# Enrichment analysis for ontology
445gget enrichr -db ontology ACE2 AGT AGTR1
447# Save KEGG pathways
448gget enrichr -db pathway ACE2 AGT AGTR1 -ko ./kegg_images/
449```
451```python
452# Python with plot
453gget.enrichr(["ACE2", "AGT", "AGTR1"], database="ontology", plot=True)
454```
456#### gget bgee - Orthology & Expression
458Retrieve orthology and gene expression data from Bgee database.
460**Parameters**:
461- `ens_id`: Ensembl gene ID or NCBI gene ID (for non-Ensembl species). Multiple IDs supported when `type=expression`
462- `-t/--type`: 'orthologs' (default) or 'expression'
464**Returns**:
465- **Orthologs mode**: Matching genes across species with IDs, names, taxonomic info
466- **Expression mode**: Anatomical entities, confidence scores, expression status
468**Examples**:
469```bash
470# Get orthologs
471gget bgee ENSG00000169194
473# Get expression data
474gget bgee ENSG00000169194 -t expression
476# Multiple genes
477gget bgee ENSBTAG00000047356 ENSBTAG00000018317 -t expression
478```
480```python
481# Python
482gget.bgee("ENSG00000169194", type="orthologs")
483```
485#### gget opentargets - Disease & Drug Associations
487Retrieve disease and drug associations from OpenTargets.
489**Parameters**:
490- Ensembl gene ID (required)
491- `-r/--resource`: diseases (default), drugs, tractability, pharmacogenetics, expression, depmap, interactions
492- `-l/--limit`: Cap results count
493- `--filter`: Exact-match filters using returned OpenTargets column names; repeat on the CLI or pass a Python dict
494- Filters use AND logic; there is no `--or` option in the released 0.30.8 CLI
496**Current notes**:
497- gget 0.30.8 returns dot-separated columns, including `disease.name`, `score`, `drug.name`, and `drug.maximumClinicalStage`.
498- Expression is `baselineExpression`: `median/min/q1/q3/max/unit` and `tissueBiosample.*`/`celltypeBiosample.*`.
499- Filters apply locally after limit. Expression fetches one page (max 3000); diseases/drugs/interactions use server default pages. `limit=None` does not make a complete export.
500- The older `--filter_mode` argument was removed upstream.
502**Examples**:
503```bash
504# Get associated diseases
505gget opentargets ENSG00000169194 -r diseases -l 5
507# Get associated drugs
508gget opentargets ENSG00000169194 -r drugs -l 10
510# Filter interactions by returned column names
511gget opentargets ENSG00000169194 -r interactions --filter intA=P35225 --filter targetB.id=ENSG00000077238
512```
514```python
515# Python
516gget.opentargets("ENSG00000169194", resource="diseases", limit=5)
517gget.opentargets(
518 "ENSG00000169194",
519 resource="interactions",
520 filters={"intA": "P35225", "targetB.id": "ENSG00000077238"},
522```
524#### gget cbio - cBioPortal Cancer Genomics
526Plot cancer genomics heatmaps using cBioPortal data.
528**Setup:** `gget setup cbio` installs optional dependencies.
530**Two subcommands**:
532**search** - Find study IDs:
533```bash
534gget cbio search breast lung
535```
537**plot** - Generate heatmaps:
539**Parameters**:
540- `-s/--study_ids`: Space-separated cBioPortal study IDs (required)
541- `-g/--genes`: Space-separated gene names or Ensembl IDs (required)
542- `-st/--stratification`: Column to organize data (tissue, cancer_type, cancer_type_detailed, study_id, sample)
543- `-vt/--variation_type`: Data type (mutation_occurrences, cna_nonbinary, sv_occurrences, cna_occurrences, Consequence)
544- `-f/--filter`: Filter by column value (e.g., 'study_id:msk_impact_2017')
545- `-dd/--data_dir`: Cache directory (default: ./gget_cbio_cache)
546- `-fd/--figure_dir`: Output directory (default: ./gget_cbio_figures)
547- `-dpi`: Resolution (default: 100)
548- `-sh/--show`: Display plot in window
549- `-nc/--no_confirm`: Skip download confirmations
551**Examples**:
552```bash
553# Search for studies
554gget cbio search esophag ovary
556# Create heatmap
557gget cbio plot -s msk_impact_2017 -g AKT1 ALK BRAF -st tissue -vt mutation_occurrences
558```
560```python
561# Python
562gget.cbio_search(["esophag", "ovary"])
563gget.cbio_plot(["msk_impact_2017"], ["AKT1", "ALK"], stratification="tissue")
564```
566#### gget cosmic - COSMIC Database
568Search COSMIC (Catalogue Of Somatic Mutations In Cancer) database.
570**Important**: License fees apply for commercial use. Requires COSMIC account credentials.
571Avoid passing COSMIC credentials directly as CLI arguments on shared systems because command-line arguments can be exposed in shell history, process listings, and logs. Prefer the interactive prompt (`gget cosmic --download_cosmic ...`) or named environment variables read inside Python.
573**Parameters**:
574- `searchterm`: Gene name, Ensembl ID, mutation notation, or sample ID
575- `-ctp/--cosmic_tsv_path`: Path to downloaded COSMIC TSV file (required for querying)
576- `-l/--limit`: Maximum results (default: 100)
578**Database download flags**:
579- `-d/--download_cosmic`: Activate download mode
580- `-gm/--gget_mutate`: Create version for gget mutate
581- `-cp/--cosmic_project`: Database type (cancer, cancer_example, census, cell_line, resistance, genome_screen, targeted_screen)
582- `-cv/--cosmic_version`: COSMIC version
583- `-gv/--grch_version`: Human reference genome (37 or 38)
584- `--email`, `--password`: COSMIC credentials for non-interactive downloads; prefer prompt or Python env vars
586**Examples**:
587```bash
588# First download database; gget prompts for COSMIC email/password
589gget cosmic --download_cosmic --cosmic_project cancer
591# Then query
592gget cosmic EGFR --cosmic_tsv_path "CancerMutationCensus_AllData_Tsv_v101_GRCh37/CancerMutationCensus_AllData_v101_GRCh37.tsv" -l 10
593```
595```python
596# Python
597import os
599gget.cosmic(
600 searchterm=None,
601 download_cosmic=True,
602 cosmic_project="cancer",
603 email=os.environ["COSMIC_EMAIL"],
604 password=os.environ["COSMIC_PASSWORD"],
606gget.cosmic("EGFR", cosmic_tsv_path="cosmic_data.tsv", limit=10)
607```

4. Expression & Disease Data

gget archs4 - Gene Correlation & Tissue Expression

Query ARCHS4 database for correlated genes or tissue expression data.

Parameters:

  • gene: Gene symbol or Ensembl ID (with --ensembl flag)
  • -w/--which: 'correlation' (default, returns 100 most correlated genes) or 'tissue' (expression atlas)
  • -s/--species: 'human' (default) or 'mouse' (tissue data only)
  • -e/--ensembl: Input is Ensembl ID

Returns:

  • Correlation mode: gene_symbol, pearson_correlation (human only; Python gene_count controls count)
  • Tissue mode: id, min, q1, median, q3, max

Examples:

# Get correlated genes
gget archs4 ACE2

# Get tissue expression
gget archs4 -w tissue ACE2
# Python
gget.archs4("ACE2", which="tissue")

gget cellxgene - Single-Cell RNA-seq Data

Query CZ CELLxGENE Discover Census for single-cell data.

Setup Required:

gget setup cellxgene

Parameters:

  • --gene (-g): Gene names or Ensembl IDs (case-sensitive! 'PAX7' for human, 'Pax7' for mouse)
  • --tissue: Tissue type(s)
  • --cell_type: Specific cell type(s)
  • --species (-s): 'homo_sapiens' (default), 'mus_musculus', 'macaca_mulatta', 'callithrix_jacchus', or 'pan_troglodytes' (primates require Census 2025-11-08 or newer)
  • --census_version (-cv): Version ("stable", "latest", or dated)
  • --ensembl (-e): Use Ensembl IDs
  • --meta_only (-mo): Return metadata only
  • Additional filters: disease, development_stage, sex, assay, dataset_id, donor_id, self_reported_ethnicity, suspension_type

Returns: AnnData with raw counts; metadata-only DataFrame rows are cells, and the gene filter is ignored in that mode. Pin a dated release and scope observations.

Examples:

# Get single-cell data for specific genes and cell types
gget cellxgene --gene ACE2 ABCA1 --tissue lung --cell_type "mucus secreting cell" -o lung_data.h5ad

# Metadata only
gget cellxgene --gene PAX7 --tissue muscle --meta_only -o metadata.csv
# Python
adata = gget.cellxgene(gene=["ACE2", "ABCA1"], tissue="lung", cell_type="mucus secreting cell")

gget enrichr - Enrichment Analysis

Perform ontology enrichment analysis on gene lists using Enrichr.

Parameters:

  • genes: Gene symbols, or Ensembl IDs with ensembl=True / CLI --ensembl
  • -db/--database: Reference database (supports shortcuts: 'pathway', 'transcription', 'ontology', 'diseases_drugs', 'celltypes')
  • -s/--species: human (default), mouse, fly, yeast, worm, fish
  • -bkg_l/--background_list: Background genes for comparison
  • -ko/--kegg_out: Save KEGG pathway images with highlighted genes
  • plot: Python-only; generate graphical results

Database Shortcuts:

  • 'pathway' → KEGG_2021_Human
  • 'transcription' → ChEA_2016
  • 'ontology' → GO_Biological_Process_2021
  • 'diseases_drugs' → GWAS_Catalog_2019
  • 'celltypes' → PanglaoDB_Augmented_2021
  • 'kinase_interactions' → KEA_2015

Shortcuts apply to human/mouse only. Other species need their full library names; custom backgrounds are human/mouse only. Ensembl background IDs also require ensembl_bkg=True.

Examples:

# Enrichment analysis for ontology
gget enrichr -db ontology ACE2 AGT AGTR1

# Save KEGG pathways
gget enrichr -db pathway ACE2 AGT AGTR1 -ko ./kegg_images/
# Python with plot
gget.enrichr(["ACE2", "AGT", "AGTR1"], database="ontology", plot=True)

gget bgee - Orthology & Expression

Retrieve orthology and gene expression data from Bgee database.

Parameters:

  • ens_id: Ensembl gene ID or NCBI gene ID (for non-Ensembl species). Multiple IDs supported when type=expression
  • -t/--type: 'orthologs' (default) or 'expression'

Returns:

  • Orthologs mode: Matching genes across species with IDs, names, taxonomic info
  • Expression mode: Anatomical entities, confidence scores, expression status

Examples:

# Get orthologs
gget bgee ENSG00000169194

# Get expression data
gget bgee ENSG00000169194 -t expression

# Multiple genes
gget bgee ENSBTAG00000047356 ENSBTAG00000018317 -t expression
# Python
gget.bgee("ENSG00000169194", type="orthologs")

gget opentargets - Disease & Drug Associations

Retrieve disease and drug associations from OpenTargets.

Parameters:

  • Ensembl gene ID (required)
  • -r/--resource: diseases (default), drugs, tractability, pharmacogenetics, expression, depmap, interactions
  • -l/--limit: Cap results count
  • --filter: Exact-match filters using returned OpenTargets column names; repeat on the CLI or pass a Python dict
  • Filters use AND logic; there is no --or option in the released 0.30.8 CLI

Current notes:

  • gget 0.30.8 returns dot-separated columns, including disease.name, score, drug.name, and drug.maximumClinicalStage.
  • Expression is baselineExpression: median/min/q1/q3/max/unit and tissueBiosample.*/celltypeBiosample.*.
  • Filters apply locally after limit. Expression fetches one page (max 3000); diseases/drugs/interactions use server default pages. limit=None does not make a complete export.
  • The older --filter_mode argument was removed upstream.

Examples:

# Get associated diseases
gget opentargets ENSG00000169194 -r diseases -l 5

# Get associated drugs
gget opentargets ENSG00000169194 -r drugs -l 10

# Filter interactions by returned column names
gget opentargets ENSG00000169194 -r interactions --filter intA=P35225 --filter targetB.id=ENSG00000077238
# Python
gget.opentargets("ENSG00000169194", resource="diseases", limit=5)
gget.opentargets(
    "ENSG00000169194",
    resource="interactions",
    filters={"intA": "P35225", "targetB.id": "ENSG00000077238"},
)

gget cbio - cBioPortal Cancer Genomics

Plot cancer genomics heatmaps using cBioPortal data.

Setup: gget setup cbio installs optional dependencies.

Two subcommands:

search - Find study IDs:

gget cbio search breast lung

plot - Generate heatmaps:

Parameters:

  • -s/--study_ids: Space-separated cBioPortal study IDs (required)
  • -g/--genes: Space-separated gene names or Ensembl IDs (required)
  • -st/--stratification: Column to organize data (tissue, cancer_type, cancer_type_detailed, study_id, sample)
  • -vt/--variation_type: Data type (mutation_occurrences, cna_nonbinary, sv_occurrences, cna_occurrences, Consequence)
  • -f/--filter: Filter by column value (e.g., 'study_id:msk_impact_2017')
  • -dd/--data_dir: Cache directory (default: ./gget_cbio_cache)
  • -fd/--figure_dir: Output directory (default: ./gget_cbio_figures)
  • -dpi: Resolution (default: 100)
  • -sh/--show: Display plot in window
  • -nc/--no_confirm: Skip download confirmations

Examples:

# Search for studies
gget cbio search esophag ovary

# Create heatmap
gget cbio plot -s msk_impact_2017 -g AKT1 ALK BRAF -st tissue -vt mutation_occurrences
# Python
gget.cbio_search(["esophag", "ovary"])
gget.cbio_plot(["msk_impact_2017"], ["AKT1", "ALK"], stratification="tissue")

gget cosmic - COSMIC Database

Search COSMIC (Catalogue Of Somatic Mutations In Cancer) database.

Important: License fees apply for commercial use. Requires COSMIC account credentials. Avoid passing COSMIC credentials directly as CLI arguments on shared systems because command-line arguments can be exposed in shell history, process listings, and logs. Prefer the interactive prompt (gget cosmic --download_cosmic ...) or named environment variables read inside Python.

Parameters:

  • searchterm: Gene name, Ensembl ID, mutation notation, or sample ID
  • -ctp/--cosmic_tsv_path: Path to downloaded COSMIC TSV file (required for querying)
  • -l/--limit: Maximum results (default: 100)

Database download flags:

  • -d/--download_cosmic: Activate download mode
  • -gm/--gget_mutate: Create version for gget mutate
  • -cp/--cosmic_project: Database type (cancer, cancer_example, census, cell_line, resistance, genome_screen, targeted_screen)
  • -cv/--cosmic_version: COSMIC version
  • -gv/--grch_version: Human reference genome (37 or 38)
  • --email, --password: COSMIC credentials for non-interactive downloads; prefer prompt or Python env vars

Examples:

# First download database; gget prompts for COSMIC email/password
gget cosmic --download_cosmic --cosmic_project cancer

# Then query
gget cosmic EGFR --cosmic_tsv_path "CancerMutationCensus_AllData_Tsv_v101_GRCh37/CancerMutationCensus_AllData_v101_GRCh37.tsv" -l 10
# Python
import os

gget.cosmic(
    searchterm=None,
    download_cosmic=True,
    cosmic_project="cancer",
    email=os.environ["COSMIC_EMAIL"],
    password=os.environ["COSMIC_PASSWORD"],
)
gget.cosmic("EGFR", cosmic_tsv_path="cosmic_data.tsv", limit=10)
Raw lines 355 to 608
609### 5. Viral & Mouse Specificity Data
611#### gget virus - Viral Sequence Downloads
613Download viral nucleotide sequences plus linked metadata from INSDC sources via NCBI Virus, with optional GenBank metadata enrichment. Results are saved to an output folder as FASTA, CSV, JSONL, and a command summary file.
615**Parameters**:
616- `virus`: Virus taxon name, taxon ID, accession, space-separated accessions, or path to a text file of accessions
617- `-a/--is_accession`: Treat `virus` as accession input
618- `--is_sars_cov2`, `--is_alphainfluenza`: Use optimized cached NCBI datasets paths for SARS-CoV-2 or Influenza A
619- `--host`: Host organism name or NCBI taxonomy ID
620- `--nuc_completeness`: complete or partial
621- `--min_seq_length`, `--max_seq_length`: Sequence length filters
622- `-g/--genbank_metadata`: Fetch detailed GenBank metadata; auto-enabled by some annotation filters
623- `--segment`, `--vaccine_strain`, `--annotated`, `--lab_passaged`, `--source_database`: Common viral metadata filters
624- `--download_all_accessions`: Apply filters across all viral accessions
625- `--baseline`, `--merge-results`: Resume or merge with prior metadata from partial/previous runs
627**Important**: Do not use `--download_all_accessions` without restrictive filters; it can attempt to download the entire Viruses taxonomy and consume substantial time, bandwidth, and disk.
629**Examples**:
630```bash
631# Complete Zika genomes from human hosts
632gget virus "Zika virus" --nuc_completeness complete --host human --out zika_data
634# SARS-CoV-2 reference genome by accession
635gget virus NC_045512.2 --is_accession --is_sars_cov2
636```
638```python
639# Python
640gget.virus(
641 "SARS-CoV-2",
642 host="human",
643 nuc_completeness="complete",
644 min_seq_length=29000,
645 genbank_metadata=True,
646 is_sars_cov2=True,
647 outfolder="covid_data",
649```
651#### gget 8cube - Mouse Specificity & Expression
653Query 8cubeDB for snRNA-seq gene specificity metrics and normalized expression values across mouse strains, tissues, sexes, and individuals.
655**Subcommands**:
656- `gget 8cube specificity <genes...>`: Return gene-level psi/zeta specificity statistics
657- `gget 8cube psi_block <genes...> --analysis_level <level> --analysis_type <type>`: Return block-level specificity
658- `gget 8cube expression <genes...> --analysis_level <level> --analysis_type <type>`: Return mean/variance normalized expression
660**Examples**:
661```bash
662gget 8cube specificity Acsm2 ENSMUSG00000046623.9
663gget 8cube psi_block Acsm2 --analysis_level Kidney --analysis_type "Sex:Celltype"
664gget 8cube expression Gjb4 --analysis_level Across_tissues --analysis_type Strain
665```
667```python
668# Python
669from gget import specificity, psi_block, gene_expression
671specificity(["Acsm2", "ENSMUSG00000046623.9"])
672psi_block(["Acsm2"], analysis_level="Kidney", analysis_type="Sex:Celltype")
673gene_expression(["Gjb4"], analysis_level="Across_tissues", analysis_type="Strain")
674```

5. Viral & Mouse Specificity Data

gget virus - Viral Sequence Downloads

Download viral nucleotide sequences plus linked metadata from INSDC sources via NCBI Virus, with optional GenBank metadata enrichment. Results are saved to an output folder as FASTA, CSV, JSONL, and a command summary file.

Parameters:

  • virus: Virus taxon name, taxon ID, accession, space-separated accessions, or path to a text file of accessions
  • -a/--is_accession: Treat virus as accession input
  • --is_sars_cov2, --is_alphainfluenza: Use optimized cached NCBI datasets paths for SARS-CoV-2 or Influenza A
  • --host: Host organism name or NCBI taxonomy ID
  • --nuc_completeness: complete or partial
  • --min_seq_length, --max_seq_length: Sequence length filters
  • -g/--genbank_metadata: Fetch detailed GenBank metadata; auto-enabled by some annotation filters
  • --segment, --vaccine_strain, --annotated, --lab_passaged, --source_database: Common viral metadata filters
  • --download_all_accessions: Apply filters across all viral accessions
  • --baseline, --merge-results: Resume or merge with prior metadata from partial/previous runs

Important: Do not use --download_all_accessions without restrictive filters; it can attempt to download the entire Viruses taxonomy and consume substantial time, bandwidth, and disk.

Examples:

# Complete Zika genomes from human hosts
gget virus "Zika virus" --nuc_completeness complete --host human --out zika_data

# SARS-CoV-2 reference genome by accession
gget virus NC_045512.2 --is_accession --is_sars_cov2
# Python
gget.virus(
    "SARS-CoV-2",
    host="human",
    nuc_completeness="complete",
    min_seq_length=29000,
    genbank_metadata=True,
    is_sars_cov2=True,
    outfolder="covid_data",
)

gget 8cube - Mouse Specificity & Expression

Query 8cubeDB for snRNA-seq gene specificity metrics and normalized expression values across mouse strains, tissues, sexes, and individuals.

Subcommands:

  • gget 8cube specificity <genes...>: Return gene-level psi/zeta specificity statistics
  • gget 8cube psi_block <genes...> --analysis_level <level> --analysis_type <type>: Return block-level specificity
  • gget 8cube expression <genes...> --analysis_level <level> --analysis_type <type>: Return mean/variance normalized expression

Examples:

gget 8cube specificity Acsm2 ENSMUSG00000046623.9
gget 8cube psi_block Acsm2 --analysis_level Kidney --analysis_type "Sex:Celltype"
gget 8cube expression Gjb4 --analysis_level Across_tissues --analysis_type Strain
# Python
from gget import specificity, psi_block, gene_expression

specificity(["Acsm2", "ENSMUSG00000046623.9"])
psi_block(["Acsm2"], analysis_level="Kidney", analysis_type="Sex:Celltype")
gene_expression(["Gjb4"], analysis_level="Across_tissues", analysis_type="Strain")
Raw lines 609 to 675
676### 6. Additional Tools
678#### gget mutate - Generate Mutated Sequences
680Generate mutated nucleotide sequences from mutation annotations.
682**Scope**: Applies mutation annotations to supplied nucleotide sequences. Python returns raw mutated sequence strings when `out` is omitted; `out` writes FASTA. Verify the exact transcript/CDS and reference bases before applying `c.` coordinates; this does not assess functional impact. Broader variant-screening workflows are maintained in the upstream `kvar` project.
684**Parameters**:
685- `sequences`: FASTA file path or direct nucleotide sequence input (string/list)
686- `-m/--mutations`: Mutation string/list, CSV/TSV path, or DataFrame with mutation data (required)
687- `-mc/--mut_column`: Mutation column name (default: 'mutation')
688- `-sic/--seq_id_column`: Sequence ID column (default: 'seq_ID')
689- `-mic/--mut_id_column`: Mutation ID column (default: same as mut_column)
690- `-k/--k`: Length of flanking sequences (default: 30 nucleotides)
691- `-o/--out`: Output FASTA path; without it Python returns a list of mutated sequences
693**Returns**: List of mutated sequence strings in Python; `out` writes FASTA
695**Examples**:
696```bash
697# Single mutation
698gget mutate ATCGCTAAGCT -m "c.4G>T"
700# Multiple sequences with one mutation per sequence
701gget mutate ATCGCTAAGCT TAGCTA -m "c.4G>T" "c.1_3inv" -o mutated.fasta
702```
704```python
705# Python
706gget.mutate("ATCGCTAAGCT", "c.4G>T")
707gget.mutate(["ATCGCTAAGCT", "TAGCTA"], ["c.4G>T", "c.1_3inv"], out="mutated.fasta")
708```
710#### gget gpt - OpenAI Text Generation
712Legacy OpenAI wrapper; deprecated and no longer actively maintained since 0.30.7. Examples below are illustrative and require an account-compatible model.
714**Setup Required**:
715```bash
716gget setup gpt
717```
719**Important**: Requires an OpenAI API key. Do not hard-code the key in notebooks, scripts, shell history, or committed files. Prefer a named environment variable such as `OPENAI_API_KEY`, and inspect the account and model requirements before use.
721**Parameters**:
722- `prompt`: Text input for generation (required)
723- `api_key`: OpenAI authentication (required by the upstream API)
724- Model configuration: model, temperature, top_p, stop, max_tokens, frequency_penalty, presence_penalty, logit_bias
725- Default model: gpt-3.5-turbo (upstream default; verify available models in your OpenAI account)
727**Examples**:
728For CLI usage, `gget gpt` expects the API key as an argument. Avoid this on shared systems because process arguments can be visible to other users.
730```python
731# Python
732import os
734# Legacy wrapper uses openai.ChatCompletion.create, removed by modern SDKs.
735# Do not execute it in a modern SDK environment or assume the default model exists.
736```
738#### gget setup - Install Dependencies
740Install/download third-party dependencies for specific modules.
742As of gget 0.29.2, `gget setup` tries `uv pip install` first for Python dependencies and falls back to plain `pip install` if uv is unavailable or fails.
744**Parameters**:
745- `module`: Module name requiring dependency installation
746- `-o/--out`: Output folder path (elm module only)
748**Modules requiring setup**:
749- `alphafold` - Downloads ~4GB of model parameters
750- `cbio` - Installs optional cBioPortal dependencies (bravado)
751- `cellxgene` - Installs cellxgene-census (may require Python 3.12/3.13 if the latest Python is unsupported)
752- `elm` - Downloads local ELM database
753- `gpt` - Installs/configures OpenAI integration dependencies
755**Examples**:
756```bash
757# Setup AlphaFold
758gget setup alphafold
760# Setup ELM with custom directory
761gget setup elm -o /path/to/elm_data
762```
764```python
765# Python
766gget.setup("alphafold")
767```

6. Additional Tools

gget mutate - Generate Mutated Sequences

Generate mutated nucleotide sequences from mutation annotations.

Scope: Applies mutation annotations to supplied nucleotide sequences. Python returns raw mutated sequence strings when out is omitted; out writes FASTA. Verify the exact transcript/CDS and reference bases before applying c. coordinates; this does not assess functional impact. Broader variant-screening workflows are maintained in the upstream kvar project.

Parameters:

  • sequences: FASTA file path or direct nucleotide sequence input (string/list)
  • -m/--mutations: Mutation string/list, CSV/TSV path, or DataFrame with mutation data (required)
  • -mc/--mut_column: Mutation column name (default: 'mutation')
  • -sic/--seq_id_column: Sequence ID column (default: 'seq_ID')
  • -mic/--mut_id_column: Mutation ID column (default: same as mut_column)
  • -k/--k: Length of flanking sequences (default: 30 nucleotides)
  • -o/--out: Output FASTA path; without it Python returns a list of mutated sequences

Returns: List of mutated sequence strings in Python; out writes FASTA

Examples:

# Single mutation
gget mutate ATCGCTAAGCT -m "c.4G>T"

# Multiple sequences with one mutation per sequence
gget mutate ATCGCTAAGCT TAGCTA -m "c.4G>T" "c.1_3inv" -o mutated.fasta
# Python
gget.mutate("ATCGCTAAGCT", "c.4G>T")
gget.mutate(["ATCGCTAAGCT", "TAGCTA"], ["c.4G>T", "c.1_3inv"], out="mutated.fasta")

gget gpt - OpenAI Text Generation

Legacy OpenAI wrapper; deprecated and no longer actively maintained since 0.30.7. Examples below are illustrative and require an account-compatible model.

Setup Required:

gget setup gpt

Important: Requires an OpenAI API key. Do not hard-code the key in notebooks, scripts, shell history, or committed files. Prefer a named environment variable such as OPENAI_API_KEY, and inspect the account and model requirements before use.

Parameters:

  • prompt: Text input for generation (required)
  • api_key: OpenAI authentication (required by the upstream API)
  • Model configuration: model, temperature, top_p, stop, max_tokens, frequency_penalty, presence_penalty, logit_bias
  • Default model: gpt-3.5-turbo (upstream default; verify available models in your OpenAI account)

Examples: For CLI usage, gget gpt expects the API key as an argument. Avoid this on shared systems because process arguments can be visible to other users.

# Python
import os

# Legacy wrapper uses openai.ChatCompletion.create, removed by modern SDKs.
# Do not execute it in a modern SDK environment or assume the default model exists.

gget setup - Install Dependencies

Install/download third-party dependencies for specific modules.

As of gget 0.29.2, gget setup tries uv pip install first for Python dependencies and falls back to plain pip install if uv is unavailable or fails.

Parameters:

  • module: Module name requiring dependency installation
  • -o/--out: Output folder path (elm module only)

Modules requiring setup:

  • alphafold - Downloads ~4GB of model parameters
  • cbio - Installs optional cBioPortal dependencies (bravado)
  • cellxgene - Installs cellxgene-census (may require Python 3.12/3.13 if the latest Python is unsupported)
  • elm - Downloads local ELM database
  • gpt - Installs/configures OpenAI integration dependencies

Examples:

# Setup AlphaFold
gget setup alphafold

# Setup ELM with custom directory
gget setup elm -o /path/to/elm_data
# Python
gget.setup("alphafold")
Raw lines 676 to 767