gget Database Information
Overview of databases queried by gget modules, including update frequencies and important considerations.
Important Note
The databases queried by gget are continuously being updated, which sometimes changes their structure. gget modules are tested automatically on a biweekly basis and updated to match new database structures when necessary. Always keep gget updated:
pip install --upgrade gget
Database Directory
Genomic Reference Databases
Ensembl
- Used by: gget ref, gget search, gget info, gget seq
- Description: Comprehensive genome database with annotations for vertebrate and invertebrate species
- Update frequency: Regular releases (numbered); new releases approximately every 3 months
- Access: FTP downloads, REST API
- Website: https://www.ensembl.org/
- Notes:
- Supports both vertebrate and invertebrate genomes
- Can specify release number for reproducibility
- Shortcuts available for common species ('human', 'mouse')
UCSC Genome Browser
- Used by: gget blat
- Description: Genome browser database with BLAT alignment tool
- Update frequency: Regular updates with new assemblies
- Access: Web service API
- Website: https://genome.ucsc.edu/
- Notes:
- Multiple genome assemblies available (hg38, mm39, etc.)
- BLAT optimized for vertebrate genomes
Protein & Structure Databases
UniProt
- Used by: gget info, gget seq (amino acid sequences), gget elm
- Description: Universal Protein Resource, comprehensive protein sequence and functional information
- Update frequency: Regular releases (weekly for Swiss-Prot, monthly for TrEMBL)
- Access: REST API
- Website: https://www.uniprot.org/
- Notes:
- Swiss-Prot: manually annotated and reviewed
- TrEMBL: automatically annotated
NCBI (National Center for Biotechnology Information)
- Used by: gget info, gget bgee (for non-Ensembl species)
- Description: Gene and protein databases with extensive cross-references
- Update frequency: Continuous updates
- Access: E-utilities API
- Website: https://www.ncbi.nlm.nih.gov/
- Databases: Gene, Protein, RefSeq
RCSB PDB (Protein Data Bank)
- Used by: gget pdb
- Description: Repository of 3D structural data for proteins and nucleic acids
- Update frequency: Weekly updates
- Access: REST API
- Website: https://www.rcsb.org/
- Notes:
- Experimentally determined structures (X-ray, NMR, cryo-EM)
- Includes metadata about experiments and publications
ELM (Eukaryotic Linear Motif)
- Used by: gget elm
- Description: Database of functional sites in eukaryotic proteins
- Update frequency: Periodic updates
- Access: Downloaded database (via gget setup elm)
- Website: http://elm.eu.org/
- Notes:
- Requires local download before first use
- Contains validated motifs and patterns
Sequence Similarity Databases
BLAST Databases (NCBI)
- Used by: gget blast
- Description: Pre-formatted databases for BLAST searches
- Update frequency: Regular updates
- Access: NCBI BLAST API
- Databases:
- Nucleotide: nt (all GenBank), refseq_rna, pdbnt
- Protein: nr (non-redundant), swissprot, pdbaa, refseq_protein
- Notes:
- nt and nr are very large databases
- Consider specialized databases for faster, more focused searches
Expression & Correlation Databases
ARCHS4
- Used by: gget archs4
- Description: Massive mining of publicly available RNA-seq data
- Update frequency: Periodic updates with new samples
- Access: HTTP API
- Website: https://maayanlab.cloud/archs4/
- Data:
- Human and mouse RNA-seq data
- Correlation matrices
- Tissue expression atlases
- Citation: Lachmann et al., Nature Communications, 2018
CZ CELLxGENE Discover
- Used by: gget cellxgene
- Description: Single-cell RNA-seq data from multiple studies
- Update frequency: Continuous additions of new datasets
- Access: Census API (via cellxgene-census package)
- Website: https://cellxgene.cziscience.com/
- Data:
- Single-cell RNA-seq count matrices
- Cell type annotations
- Tissue and disease metadata
- Notes:
- Requires gget setup cellxgene
- Gene symbols are case-sensitive
- May not support latest Python versions
Bgee
- Used by: gget bgee
- Description: Gene expression and orthology database
- Update frequency: Regular releases
- Access: REST API
- Website: https://www.bgee.org/
- Data:
- Gene expression across tissues and developmental stages
- Orthology relationships across species
- Citation: Bastian et al., 2021
Functional & Pathway Databases
Enrichr / modEnrichr
- Used by: gget enrichr
- Description: Gene set enrichment analysis web service
- Update frequency: Regular updates to underlying databases
- Access: REST API
- Website: https://maayanlab.cloud/Enrichr/
- Databases included:
- KEGG pathways
- Gene Ontology (GO)
- Transcription factor targets (ChEA)
- Disease associations (GWAS Catalog)
- Cell type markers (PanglaoDB)
- Notes:
- Supports multiple model organisms
- Background gene lists can be provided for custom enrichment
Disease & Drug Databases
Open Targets
- Used by: gget opentargets
- Description: Integrative platform for disease-target associations
- Update frequency: Regular releases (quarterly)
- Access: GraphQL API
- Website: https://www.opentargets.org/
- Data:
- Disease associations
- Drug information and clinical trials
- Target tractability
- Pharmacogenetics
- Gene expression
- DepMap gene-disease effects
- Protein-protein interactions
cBioPortal
- Used by: gget cbio
- Description: Cancer genomics data portal
- Update frequency: Continuous addition of new studies
- Access: Web API, downloadable datasets
- Website: https://www.cbioportal.org/
- Data:
- Mutations, copy number alterations, structural variants
- Gene expression
- Clinical data
- Notes:
- Large datasets; caching recommended
- Multiple cancer types and studies available
COSMIC (Catalogue Of Somatic Mutations In Cancer)
- Used by: gget cosmic
- Description: Comprehensive cancer mutation database
- Update frequency: Regular releases
- Access: Download (requires account and license for commercial use)
- Website: https://cancer.sanger.ac.uk/cosmic
- Data:
- Somatic mutations in cancer
- Gene census
- Cell line data
- Drug resistance mutations
- Important:
- Free for academic use
- License fees apply for commercial use
- Requires COSMIC account credentials
- Must download database before querying
AI & Prediction Services
AlphaFold2 (DeepMind)
- Used by: gget alphafold
- Description: Deep learning model for protein structure prediction
- Model version: Simplified version for local execution
- Access: Local computation (requires model download via gget setup)
- Website: https://alphafold.ebi.ac.uk/
- Notes:
- Requires ~4GB model parameters download
- Requires OpenMM installation
- Computationally intensive
- Python version-specific requirements
OpenAI API
- Used by: gget gpt
- Description: Large language model API
- Update frequency: New models released periodically
- Access: REST API (requires API key)
- Website: https://openai.com/
- Notes:
- Default model: gpt-3.5-turbo
- Free tier limited to 3 months after account creation
- Set billing limits to control costs
Data Consistency & Reproducibility
Version Control
To ensure reproducibility in analyses:
Specify database versions/releases:
# Use specific Ensembl release
gget.ref("homo_sapiens", release=110)
# Use specific Census version
gget.cellxgene(gene=["PAX7"], census_version="2023-07-25")
Document gget version:
import gget
print(gget.__version__)
Save raw data:
# Always save results for reproducibility
results = gget.search(["ACE2"], species="homo_sapiens")
results.to_csv("search_results_2025-01-15.csv", index=False)
Handling Database Updates
Regular gget updates:
- Update gget biweekly to match database structure changes
- Check release notes for breaking changes
Error handling:
API rate limiting:
- Implement delays for large-scale queries
- Use local databases (DIAMOND, COSMIC) when possible
- Cache results to avoid repeated queries
Database-Specific Best Practices
Ensembl
- Use species shortcuts ('human', 'mouse') for convenience
- Specify release numbers for reproducibility
- Check available species with
gget ref --list_species
UniProt
- UniProt IDs are more stable than gene names
- Swiss-Prot annotations are manually curated and more reliable
- Use PDB flag in gget info only when needed (increases runtime)
BLAST/BLAT
- Start with default parameters, then optimize
- Use specialized databases (swissprot, refseq_protein) for focused searches
- Consider E-value cutoffs based on query length
Expression Databases
- Gene symbols are case-sensitive in CELLxGENE
- ARCHS4 correlation data is based on co-expression patterns
- Consider tissue-specificity when interpreting results
Cancer Databases
- cBioPortal: cache data locally for repeated analyses
- COSMIC: download appropriate database subset for your needs
- Respect license agreements for commercial use
Citations
When using gget, cite both the gget publication and the underlying databases:
gget:
Luebbert, L. & Pachter, L. (2023). Efficient querying of genomic reference databases with gget. Bioinformatics. https://doi.org/10.1093/bioinformatics/btac836
Database-specific citations: Check references/ directory or database websites for appropriate citations.
1---2name: 030-overview-d0122e553description: gget Database Information4---5# gget Database Information67Overview of databases queried by gget modules, including update frequencies and important considerations.89## Important Note1011The databases queried by gget are continuously being updated, which sometimes changes their structure. gget modules are tested automatically on a biweekly basis and updated to match new database structures when necessary. Always keep gget updated:1213```bash14pip install --upgrade gget15```1617## Database Directory1819### Genomic Reference Databases2021#### Ensembl22- **Used by:** gget ref, gget search, gget info, gget seq23- **Description:** Comprehensive genome database with annotations for vertebrate and invertebrate species24- **Update frequency:** Regular releases (numbered); new releases approximately every 3 months25- **Access:** FTP downloads, REST API26- **Website:** https://www.ensembl.org/27- **Notes:**28 - Supports both vertebrate and invertebrate genomes29 - Can specify release number for reproducibility30 - Shortcuts available for common species ('human', 'mouse')3132#### UCSC Genome Browser33- **Used by:** gget blat34- **Description:** Genome browser database with BLAT alignment tool35- **Update frequency:** Regular updates with new assemblies36- **Access:** Web service API37- **Website:** https://genome.ucsc.edu/38- **Notes:**39 - Multiple genome assemblies available (hg38, mm39, etc.)40 - BLAT optimized for vertebrate genomes4142### Protein & Structure Databases4344#### UniProt45- **Used by:** gget info, gget seq (amino acid sequences), gget elm46- **Description:** Universal Protein Resource, comprehensive protein sequence and functional information47- **Update frequency:** Regular releases (weekly for Swiss-Prot, monthly for TrEMBL)48- **Access:** REST API49- **Website:** https://www.uniprot.org/50- **Notes:**51 - Swiss-Prot: manually annotated and reviewed52 - TrEMBL: automatically annotated5354#### NCBI (National Center for Biotechnology Information)55- **Used by:** gget info, gget bgee (for non-Ensembl species)56- **Description:** Gene and protein databases with extensive cross-references57- **Update frequency:** Continuous updates58- **Access:** E-utilities API59- **Website:** https://www.ncbi.nlm.nih.gov/60- **Databases:** Gene, Protein, RefSeq6162#### RCSB PDB (Protein Data Bank)63- **Used by:** gget pdb64- **Description:** Repository of 3D structural data for proteins and nucleic acids65- **Update frequency:** Weekly updates66- **Access:** REST API67- **Website:** https://www.rcsb.org/68- **Notes:**69 - Experimentally determined structures (X-ray, NMR, cryo-EM)70 - Includes metadata about experiments and publications7172#### ELM (Eukaryotic Linear Motif)73- **Used by:** gget elm74- **Description:** Database of functional sites in eukaryotic proteins75- **Update frequency:** Periodic updates76- **Access:** Downloaded database (via gget setup elm)77- **Website:** http://elm.eu.org/78- **Notes:**79 - Requires local download before first use80 - Contains validated motifs and patterns8182### Sequence Similarity Databases8384#### BLAST Databases (NCBI)85- **Used by:** gget blast86- **Description:** Pre-formatted databases for BLAST searches87- **Update frequency:** Regular updates88- **Access:** NCBI BLAST API89- **Databases:**90 - **Nucleotide:** nt (all GenBank), refseq_rna, pdbnt91 - **Protein:** nr (non-redundant), swissprot, pdbaa, refseq_protein92- **Notes:**93 - nt and nr are very large databases94 - Consider specialized databases for faster, more focused searches9596### Expression & Correlation Databases9798#### ARCHS499- **Used by:** gget archs4100- **Description:** Massive mining of publicly available RNA-seq data101- **Update frequency:** Periodic updates with new samples102- **Access:** HTTP API103- **Website:** https://maayanlab.cloud/archs4/104- **Data:**105 - Human and mouse RNA-seq data106 - Correlation matrices107 - Tissue expression atlases108- **Citation:** Lachmann et al., Nature Communications, 2018109110#### CZ CELLxGENE Discover111- **Used by:** gget cellxgene112- **Description:** Single-cell RNA-seq data from multiple studies113- **Update frequency:** Continuous additions of new datasets114- **Access:** Census API (via cellxgene-census package)115- **Website:** https://cellxgene.cziscience.com/116- **Data:**117 - Single-cell RNA-seq count matrices118 - Cell type annotations119 - Tissue and disease metadata120- **Notes:**121 - Requires gget setup cellxgene122 - Gene symbols are case-sensitive123 - May not support latest Python versions124125#### Bgee126- **Used by:** gget bgee127- **Description:** Gene expression and orthology database128- **Update frequency:** Regular releases129- **Access:** REST API130- **Website:** https://www.bgee.org/131- **Data:**132 - Gene expression across tissues and developmental stages133 - Orthology relationships across species134- **Citation:** Bastian et al., 2021135136### Functional & Pathway Databases137138#### Enrichr / modEnrichr139- **Used by:** gget enrichr140- **Description:** Gene set enrichment analysis web service141- **Update frequency:** Regular updates to underlying databases142- **Access:** REST API143- **Website:** https://maayanlab.cloud/Enrichr/144- **Databases included:**145 - KEGG pathways146 - Gene Ontology (GO)147 - Transcription factor targets (ChEA)148 - Disease associations (GWAS Catalog)149 - Cell type markers (PanglaoDB)150- **Notes:**151 - Supports multiple model organisms152 - Background gene lists can be provided for custom enrichment153154### Disease & Drug Databases155156#### Open Targets157- **Used by:** gget opentargets158- **Description:** Integrative platform for disease-target associations159- **Update frequency:** Regular releases (quarterly)160- **Access:** GraphQL API161- **Website:** https://www.opentargets.org/162- **Data:**163 - Disease associations164 - Drug information and clinical trials165 - Target tractability166 - Pharmacogenetics167 - Gene expression168 - DepMap gene-disease effects169 - Protein-protein interactions170171#### cBioPortal172- **Used by:** gget cbio173- **Description:** Cancer genomics data portal174- **Update frequency:** Continuous addition of new studies175- **Access:** Web API, downloadable datasets176- **Website:** https://www.cbioportal.org/177- **Data:**178 - Mutations, copy number alterations, structural variants179 - Gene expression180 - Clinical data181- **Notes:**182 - Large datasets; caching recommended183 - Multiple cancer types and studies available184185#### COSMIC (Catalogue Of Somatic Mutations In Cancer)186- **Used by:** gget cosmic187- **Description:** Comprehensive cancer mutation database188- **Update frequency:** Regular releases189- **Access:** Download (requires account and license for commercial use)190- **Website:** https://cancer.sanger.ac.uk/cosmic191- **Data:**192 - Somatic mutations in cancer193 - Gene census194 - Cell line data195 - Drug resistance mutations196- **Important:**197 - Free for academic use198 - License fees apply for commercial use199 - Requires COSMIC account credentials200 - Must download database before querying201202### AI & Prediction Services203204#### AlphaFold2 (DeepMind)205- **Used by:** gget alphafold206- **Description:** Deep learning model for protein structure prediction207- **Model version:** Simplified version for local execution208- **Access:** Local computation (requires model download via gget setup)209- **Website:** https://alphafold.ebi.ac.uk/210- **Notes:**211 - Requires ~4GB model parameters download212 - Requires OpenMM installation213 - Computationally intensive214 - Python version-specific requirements215216#### OpenAI API217- **Used by:** gget gpt218- **Description:** Large language model API219- **Update frequency:** New models released periodically220- **Access:** REST API (requires API key)221- **Website:** https://openai.com/222- **Notes:**223 - Default model: gpt-3.5-turbo224 - Free tier limited to 3 months after account creation225 - Set billing limits to control costs226227## Data Consistency & Reproducibility228229### Version Control230To ensure reproducibility in analyses:2312321. **Specify database versions/releases:**233 ```python234 # Use specific Ensembl release235 gget.ref("homo_sapiens", release=110)236237 # Use specific Census version238 gget.cellxgene(gene=["PAX7"], census_version="2023-07-25")239 ```2402412. **Document gget version:**242 ```python243 import gget244 print(gget.__version__)245 ```2462473. **Save raw data:**248 ```python249 # Always save results for reproducibility250 results = gget.search(["ACE2"], species="homo_sapiens")251 results.to_csv("search_results_2025-01-15.csv", index=False)252 ```253254### Handling Database Updates2552561. **Regular gget updates:**257 - Update gget biweekly to match database structure changes258 - Check release notes for breaking changes2592602. **Error handling:**261 - Database structure changes may cause temporary failures262 - Check GitHub issues: https://github.com/pachterlab/gget/issues263 - Update gget if errors occur2642653. **API rate limiting:**266 - Implement delays for large-scale queries267 - Use local databases (DIAMOND, COSMIC) when possible268 - Cache results to avoid repeated queries269270## Database-Specific Best Practices271272### Ensembl273- Use species shortcuts ('human', 'mouse') for convenience274- Specify release numbers for reproducibility275- Check available species with `gget ref --list_species`276277### UniProt278- UniProt IDs are more stable than gene names279- Swiss-Prot annotations are manually curated and more reliable280- Use PDB flag in gget info only when needed (increases runtime)281282### BLAST/BLAT283- Start with default parameters, then optimize284- Use specialized databases (swissprot, refseq_protein) for focused searches285- Consider E-value cutoffs based on query length286287### Expression Databases288- Gene symbols are case-sensitive in CELLxGENE289- ARCHS4 correlation data is based on co-expression patterns290- Consider tissue-specificity when interpreting results291292### Cancer Databases293- cBioPortal: cache data locally for repeated analyses294- COSMIC: download appropriate database subset for your needs295- Respect license agreements for commercial use296297## Citations298299When using gget, cite both the gget publication and the underlying databases:300301**gget:**302Luebbert, L. & Pachter, L. (2023). Efficient querying of genomic reference databases with gget. Bioinformatics. https://doi.org/10.1093/bioinformatics/btac836303304**Database-specific citations:** Check references/ directory or database websites for appropriate citations.