gget
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinesegget
gget
Overview
概述
gget is a command-line bioinformatics tool and Python package providing unified access to 20+ genomic databases and analysis methods. Query gene information, sequence analysis, protein structures, expression data, and disease associations through a consistent interface. All gget modules work both as command-line tools and as Python functions.
Important: The databases queried by gget are continuously updated, which sometimes changes their structure. gget modules are tested automatically on a biweekly basis and updated to match new database structures when necessary.
gget是一款命令行生物信息学工具和Python包,提供对20+个基因组数据库和分析方法的统一访问。通过一致的接口即可查询基因信息、进行序列分析、获取蛋白质结构、表达数据以及疾病关联信息。所有gget模块既可以作为命令行工具使用,也可以作为Python函数调用。
重要提示:gget查询的数据库会持续更新,这有时会改变其结构。gget模块每两周自动测试一次,并会在必要时更新以匹配新的数据库结构。
Installation
安装
Install gget in a clean virtual environment to avoid conflicts:
bash
undefined在干净的虚拟环境中安装gget以避免冲突:
bash
undefinedUsing uv (recommended)
使用uv(推荐)
uv uv pip install gget
uv uv pip install gget
Or using pip
或使用pip
uv pip install --upgrade gget
uv pip install --upgrade gget
In Python/Jupyter
在Python/Jupyter中
import gget
undefinedimport gget
undefinedQuick Start
快速开始
Basic usage pattern for all modules:
bash
undefined所有模块的基本使用模式:
bash
undefinedCommand-line
命令行
gget <module> [arguments] [options]
gget <module> [arguments] [options]
Python
Python
gget.module(arguments, options)
Most modules return:
- **Command-line**: JSON (default) or CSV with `-csv` flag
- **Python**: DataFrame or dictionary
Common flags across modules:
- `-o/--out`: Save results to file
- `-q/--quiet`: Suppress progress information
- `-csv`: Return CSV format (command-line only)gget.module(arguments, options)
大多数模块返回:
- **命令行**:默认返回JSON格式,添加`-csv`标志可返回CSV格式
- **Python**:DataFrame或字典格式
各模块通用标志:
- `-o/--out`:将结果保存到文件
- `-q/--quiet`:抑制进度信息输出
- `-csv`:返回CSV格式(仅命令行可用)Module Categories
模块分类
1. Reference & Gene Information
1. 参考与基因信息
gget ref - Reference Genome Downloads
gget ref - 参考基因组下载
Retrieve download links and metadata for Ensembl reference genomes.
Parameters:
- : Genus_species format (e.g., 'homo_sapiens', 'mus_musculus'). Shortcuts: 'human', 'mouse'
species - : Specify return types (gtf, cdna, dna, cds, cdrna, pep). Default: all
-w/--which - : Ensembl release number (default: latest)
-r/--release - : List available vertebrate species
-l/--list_species - : List available invertebrate species
-liv/--list_iv_species - : Return only FTP links
-ftp - : Download files (requires curl)
-d/--download
Examples:
bash
undefined获取Ensembl参考基因组的下载链接和元数据。
参数:
- :属_种格式(例如'homo_sapiens'、'mus_musculus')。快捷方式:'human'(人类)、'mouse'(小鼠)
species - :指定返回类型(gtf、cdna、dna、cds、cdrna、pep)。默认返回所有类型
-w/--which - :Ensembl版本号(默认:最新版本)
-r/--release - :列出所有可用的脊椎动物物种
-l/--list_species - :列出所有可用的无脊椎动物物种
-liv/--list_iv_species - :仅返回FTP链接
-ftp - :下载文件(需要curl)
-d/--download
示例:
bash
undefinedList available species
列出可用物种
gget ref --list_species
gget ref --list_species
Get all reference files for human
获取人类的所有参考文件
gget ref homo_sapiens
gget ref homo_sapiens
Download only GTF annotation for mouse
仅下载小鼠的GTF注释文件
gget ref -w gtf -d mouse
```pythongget ref -w gtf -d mouse
```pythonPython
Python
gget.ref("homo_sapiens")
gget.ref("mus_musculus", which="gtf", download=True)
undefinedgget.ref("homo_sapiens")
gget.ref("mus_musculus", which="gtf", download=True)
undefinedgget search - Gene Search
gget search - 基因搜索
Locate genes by name or description across species.
Parameters:
- : One or more search terms (case-insensitive)
searchwords - : Target species (e.g., 'homo_sapiens', 'mouse')
-s/--species - : Ensembl release number
-r/--release - : Return 'gene' (default) or 'transcript'
-t/--id_type - : 'or' (default) finds ANY searchword; 'and' requires ALL
-ao/--andor - : Maximum results to return
-l/--limit
Returns: ensembl_id, gene_name, ensembl_description, ext_ref_description, biotype, URL
Examples:
bash
undefined跨物种通过基因名称或描述定位基因。
参数:
- :一个或多个搜索词(不区分大小写)
searchwords - :目标物种(例如'homo_sapiens'、'mouse')
-s/--species - :Ensembl版本号
-r/--release - :返回'gene'(基因,默认)或'transcript'(转录本)类型的ID
-t/--id_type - :'or'(或,默认)表示匹配任意搜索词;'and'(与)表示必须匹配所有搜索词
-ao/--andor - :返回结果的最大数量
-l/--limit
返回内容:ensembl_id、gene_name、ensembl_description、ext_ref_description、biotype、URL
示例:
bash
undefinedSearch for GABA-related genes in human
在人类中搜索与GABA相关的基因
gget search -s human gaba gamma-aminobutyric
gget search -s human gaba gamma-aminobutyric
Find specific gene, require all terms
查找特定基因,要求匹配所有搜索词
gget search -s mouse -ao and pax7 transcription
```pythongget search -s mouse -ao and pax7 transcription
```pythonPython
Python
gget.search(["gaba", "gamma-aminobutyric"], species="homo_sapiens")
undefinedgget.search(["gaba", "gamma-aminobutyric"], species="homo_sapiens")
undefinedgget info - Gene/Transcript Information
gget info - 基因/转录本信息
Retrieve comprehensive gene and transcript metadata from Ensembl, UniProt, and NCBI.
Parameters:
- : One or more Ensembl IDs (also supports WormBase, Flybase IDs). Limit: ~1000 IDs
ens_ids - : Disable NCBI data retrieval
-n/--ncbi - : Disable UniProt data retrieval
-u/--uniprot - : Include PDB identifiers (increases runtime)
-pdb
Returns: UniProt ID, NCBI gene ID, primary gene name, synonyms, protein names, descriptions, biotype, canonical transcript
Examples:
bash
undefined从Ensembl、UniProt和NCBI获取全面的基因和转录本元数据。
参数:
- :一个或多个Ensembl ID(也支持WormBase、Flybase ID)。限制:约1000个ID
ens_ids - :禁用NCBI数据检索
-n/--ncbi - :禁用UniProt数据检索
-u/--uniprot - :包含PDB标识符(会增加运行时间)
-pdb
返回内容:UniProt ID、NCBI基因ID、主要基因名称、同义词、蛋白质名称、描述、生物类型、标准转录本
示例:
bash
undefinedGet info for multiple genes
获取多个基因的信息
gget info ENSG00000034713 ENSG00000104853 ENSG00000170296
gget info ENSG00000034713 ENSG00000104853 ENSG00000170296
Include PDB IDs
包含PDB ID
gget info ENSG00000034713 -pdb
```pythongget info ENSG00000034713 -pdb
```pythonPython
Python
gget.info(["ENSG00000034713", "ENSG00000104853"], pdb=True)
undefinedgget.info(["ENSG00000034713", "ENSG00000104853"], pdb=True)
undefinedgget seq - Sequence Retrieval
gget seq - 序列检索
Fetch nucleotide or amino acid sequences for genes and transcripts.
Parameters:
- : One or more Ensembl identifiers
ens_ids - : Fetch amino acid sequences instead of nucleotide
-t/--translate - : Return all transcript variants (gene IDs only)
-iso/--isoforms
Returns: FASTA format sequences
Examples:
bash
undefined获取基因和转录本的核苷酸或氨基酸序列。
参数:
- :一个或多个Ensembl标识符
ens_ids - :获取氨基酸序列而非核苷酸序列
-t/--translate - :返回所有转录本变体(仅适用于基因ID)
-iso/--isoforms
返回内容:FASTA格式的序列
示例:
bash
undefinedGet nucleotide sequences
获取核苷酸序列
gget seq ENSG00000034713 ENSG00000104853
gget seq ENSG00000034713 ENSG00000104853
Get all protein isoforms
获取所有蛋白质同工型
gget seq -t -iso ENSG00000034713
```pythongget seq -t -iso ENSG00000034713
```pythonPython
Python
gget.seq(["ENSG00000034713"], translate=True, isoforms=True)
undefinedgget.seq(["ENSG00000034713"], translate=True, isoforms=True)
undefined2. Sequence Analysis & Alignment
2. 序列分析与比对
gget blast - BLAST Searches
gget blast - BLAST搜索
BLAST nucleotide or amino acid sequences against standard databases.
Parameters:
- : Sequence string or path to FASTA/.txt file
sequence - : blastn, blastp, blastx, tblastn, tblastx (auto-detected)
-p/--program - :
-db/--database- Nucleotide: nt, refseq_rna, pdbnt
- Protein: nr, swissprot, pdbaa, refseq_protein
- : Max hits (default: 50)
-l/--limit - : E-value cutoff (default: 10.0)
-e/--expect - : Enable low complexity filtering
-lcf/--low_comp_filt - : Disable MegaBLAST (blastn only)
-mbo/--megablast_off
Examples:
bash
undefined在标准数据库中对核苷酸或氨基酸序列进行BLAST比对。
参数:
- :序列字符串或FASTA/.txt文件路径
sequence - :blastn、blastp、blastx、tblastn、tblastx(自动检测)
-p/--program - :
-db/--database- 核苷酸数据库:nt、refseq_rna、pdbnt
- 蛋白质数据库:nr、swissprot、pdbaa、refseq_protein
- :最大匹配结果数(默认:50)
-l/--limit - :E值阈值(默认:10.0)
-e/--expect - :启用低复杂度过滤
-lcf/--low_comp_filt - :禁用MegaBLAST(仅blastn可用)
-mbo/--megablast_off
示例:
bash
undefinedBLAST protein sequence
对蛋白质序列进行BLAST比对
gget blast MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
gget blast MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
BLAST from file with specific database
从文件中读取序列并指定数据库进行BLAST比对
gget blast sequence.fasta -db swissprot -l 10
```pythongget blast sequence.fasta -db swissprot -l 10
```pythonPython
Python
gget.blast("MKWMFK...", database="swissprot", limit=10)
undefinedgget.blast("MKWMFK...", database="swissprot", limit=10)
undefinedgget blat - BLAT Searches
gget blat - BLAT搜索
Locate genomic positions of sequences using UCSC BLAT.
Parameters:
- : Sequence string or path to FASTA/.txt file
sequence - : 'DNA', 'protein', 'translated%20RNA', 'translated%20DNA' (auto-detected)
-st/--seqtype - : Target assembly (default: 'human'/hg38; options: 'mouse'/mm39, 'zebrafinch'/taeGut2, etc.)
-a/--assembly
Returns: genome, query size, alignment positions, matches, mismatches, alignment percentage
Examples:
bash
undefined使用UCSC BLAT定位序列在基因组中的位置。
参数:
- :序列字符串或FASTA/.txt文件路径
sequence - :'DNA'、'protein'、'translated%20RNA'、'translated%20DNA'(自动检测)
-st/--seqtype - :目标基因组组装版本(默认:'human'/hg38;可选:'mouse'/mm39、'zebrafinch'/taeGut2等)
-a/--assembly
返回内容:基因组、查询序列长度、比对位置、匹配数、错配数、比对百分比
示例:
bash
undefinedFind genomic location in human
在人类基因组中查找序列位置
gget blat ATCGATCGATCGATCG
gget blat ATCGATCGATCGATCG
Search in different assembly
在其他组装版本中搜索
gget blat -a mm39 ATCGATCGATCGATCG
```pythongget blat -a mm39 ATCGATCGATCGATCG
```pythonPython
Python
gget.blat("ATCGATCGATCGATCG", assembly="mouse")
undefinedgget.blat("ATCGATCGATCGATCG", assembly="mouse")
undefinedgget muscle - Multiple Sequence Alignment
gget muscle - 多序列比对
Align multiple nucleotide or amino acid sequences using Muscle5.
Parameters:
- : Sequences or path to FASTA/.txt file
fasta - : Use Super5 algorithm for faster processing (large datasets)
-s5/--super5
Returns: Aligned sequences in ClustalW format or aligned FASTA (.afa)
Examples:
bash
undefined使用Muscle5对多个核苷酸或氨基酸序列进行比对。
参数:
- :序列或FASTA/.txt文件路径
fasta - :使用Super5算法以加快处理速度(适用于大型数据集)
-s5/--super5
返回内容:ClustalW格式的比对序列或比对后的FASTA文件(.afa)
示例:
bash
undefinedAlign sequences from file
对文件中的序列进行比对
gget muscle sequences.fasta -o aligned.afa
gget muscle sequences.fasta -o aligned.afa
Use Super5 for large dataset
对大型数据集使用Super5算法
gget muscle large_dataset.fasta -s5
```pythongget muscle large_dataset.fasta -s5
```pythonPython
Python
gget.muscle("sequences.fasta", save=True)
undefinedgget.muscle("sequences.fasta", save=True)
undefinedgget diamond - Local Sequence Alignment
gget diamond - 局部序列比对
Perform fast local protein or translated DNA alignment using DIAMOND.
Parameters:
- Query: Sequences (string/list) or FASTA file path
- : Reference sequences (string/list) or FASTA file path (required)
--reference - : fast, mid-sensitive, sensitive, more-sensitive, very-sensitive (default), ultra-sensitive
--sensitivity - : CPU threads (default: 1)
--threads - : Save database for reuse
--diamond_db - : Enable nucleotide-to-amino acid alignment
--translated
Returns: Identity percentage, sequence lengths, match positions, gap openings, E-values, bit scores
Examples:
bash
undefined使用DIAMOND进行快速的蛋白质或翻译后DNA局部比对。
参数:
- Query:序列(字符串/列表)或FASTA文件路径
- :参考序列(字符串/列表)或FASTA文件路径(必填)
--reference - :比对灵敏度(fast、mid-sensitive、sensitive、more-sensitive、very-sensitive(默认)、ultra-sensitive)
--sensitivity - :CPU线程数(默认:1)
--threads - :保存数据库以供重复使用
--diamond_db - :启用核苷酸到氨基酸的比对
--translated
返回内容:一致性百分比、序列长度、匹配位置、空位开放数、E值、比特值
示例:
bash
undefinedAlign against reference
与参考序列进行比对
gget diamond GGETISAWESQME -ref reference.fasta --threads 4
gget diamond GGETISAWESQME -ref reference.fasta --threads 4
Save database for reuse
保存数据库以供重复使用
gget diamond query.fasta -ref ref.fasta --diamond_db my_db.dmnd
```pythongget diamond query.fasta -ref ref.fasta --diamond_db my_db.dmnd
```pythonPython
Python
gget.diamond("GGETISAWESQME", reference="reference.fasta", threads=4)
undefinedgget.diamond("GGETISAWESQME", reference="reference.fasta", threads=4)
undefined3. Structural & Protein Analysis
3. 结构与蛋白质分析
gget pdb - Protein Structures
gget pdb - 蛋白质结构
Query RCSB Protein Data Bank for structure and metadata.
Parameters:
- : PDB identifier (e.g., '7S7U')
pdb_id - : Data type (pdb, entry, pubmed, assembly, entity types)
-r/--resource - : Assembly, entity, or chain ID
-i/--identifier
Returns: PDB format (structures) or JSON (metadata)
Examples:
bash
undefined查询RCSB蛋白质数据库(Protein Data Bank)获取结构和元数据。
参数:
- :PDB标识符(例如'7S7U')
pdb_id - :数据类型(pdb、entry、pubmed、assembly、entity types)
-r/--resource - :组装体、实体或链ID
-i/--identifier
返回内容:PDB格式(结构)或JSON格式(元数据)
示例:
bash
undefinedDownload PDB structure
下载PDB结构
gget pdb 7S7U -o 7S7U.pdb
gget pdb 7S7U -o 7S7U.pdb
Get metadata
获取元数据
gget pdb 7S7U -r entry
```pythongget pdb 7S7U -r entry
```pythonPython
Python
gget.pdb("7S7U", save=True)
undefinedgget.pdb("7S7U", save=True)
undefinedgget alphafold - Protein Structure Prediction
gget alphafold - 蛋白质结构预测
Predict 3D protein structures using simplified AlphaFold2.
Setup Required:
bash
undefined使用简化版AlphaFold2预测蛋白质的3D结构。
前置设置:
bash
undefinedInstall OpenMM first
先安装OpenMM
uv pip install openmm
uv pip install openmm
Then setup AlphaFold
然后设置AlphaFold
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; recommend 20 for accuracy)
- `-mfm/--multimer_for_monomer`: Apply multimer model to single proteins
- `-r/--relax`: AMBER relaxation for top-ranked model
- `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**:
```bashgget setup alphafold
**参数**:
- `sequence`:氨基酸序列(字符串)、多个序列(列表)或FASTA文件。多个序列会触发多聚体建模
- `-mr/--multimer_recycles`:循环迭代次数(默认:3;为提高准确性建议设置为20)
- `-mfm/--multimer_for_monomer`:对单个蛋白质应用多聚体模型
- `-r/--relax`:对排名最高的模型进行AMBER松弛处理
- `plot`:仅Python可用;生成交互式3D可视化(默认:True)
- `show_sidechains`:仅Python可用;包含侧链(默认:True)
**返回内容**:PDB结构文件、JSON格式的比对误差数据、可选的3D可视化
**示例**:
```bashPredict single protein structure
预测单个蛋白质结构
gget alphafold MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
gget alphafold MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
Predict multimer with higher accuracy
以更高准确性预测多聚体结构
gget alphafold sequence1.fasta -mr 20 -r
```pythongget alphafold sequence1.fasta -mr 20 -r
```pythonPython with visualization
Python(带可视化)
gget.alphafold("MKWMFK...", plot=True, show_sidechains=True)
gget.alphafold("MKWMFK...", plot=True, show_sidechains=True)
Multimer prediction
多聚体预测
gget.alphafold(["sequence1", "sequence2"], multimer_recycles=20)
undefinedgget.alphafold(["sequence1", "sequence2"], multimer_recycles=20)
undefinedgget elm - Eukaryotic Linear Motifs
gget elm - 真核生物线性基序
Predict Eukaryotic Linear Motifs in protein sequences.
Setup Required:
bash
gget setup elmParameters:
- : Amino acid sequence or UniProt Acc
sequence - : Indicates sequence is UniProt Acc
-u/--uniprot - : Include protein names, organisms, references
-e/--expand - : DIAMOND alignment sensitivity (default: "very-sensitive")
-s/--sensitivity - : Number of threads (default: 1)
-t/--threads
Returns: Two outputs:
- ortholog_df: Linear motifs from orthologous proteins
- regex_df: Motifs directly matched in input sequence
Examples:
bash
undefined预测蛋白质序列中的真核生物线性基序(Eukaryotic Linear Motifs)。
前置设置:
bash
gget setup elm参数:
- :氨基酸序列或UniProt登录号
sequence - :表示输入的是UniProt登录号
-u/--uniprot - :包含蛋白质名称、生物、参考文献
-e/--expand - :DIAMOND比对灵敏度(默认:"very-sensitive")
-s/--sensitivity - :线程数(默认:1)
-t/--threads
返回内容:两个输出:
- ortholog_df:同源蛋白质中的线性基序
- regex_df:直接匹配输入序列的基序
示例:
bash
undefinedPredict motifs from sequence
预测序列中的基序
gget elm LIAQSIGQASFV -o results
gget elm LIAQSIGQASFV -o results
Use UniProt accession with expanded info
使用UniProt登录号并获取扩展信息
gget elm --uniprot Q02410 -e
```pythongget elm --uniprot Q02410 -e
```pythonPython
Python
ortholog_df, regex_df = gget.elm("LIAQSIGQASFV")
undefinedortholog_df, regex_df = gget.elm("LIAQSIGQASFV")
undefined4. Expression & Disease Data
4. 表达与疾病数据
gget archs4 - Gene Correlation & Tissue Expression
gget archs4 - 基因相关性与组织表达
Query ARCHS4 database for correlated genes or tissue expression data.
Parameters:
- : Gene symbol or Ensembl ID (with
geneflag)--ensembl - : 'correlation' (default, returns 100 most correlated genes) or 'tissue' (expression atlas)
-w/--which - : 'human' (default) or 'mouse' (tissue data only)
-s/--species - : Input is Ensembl ID
-e/--ensembl
Returns:
- Correlation mode: Gene symbols, Pearson correlation coefficients
- Tissue mode: Tissue identifiers, min/Q1/median/Q3/max expression values
Examples:
bash
undefined查询ARCHS4数据库获取相关基因或组织表达数据。
参数:
- :基因符号或Ensembl ID(需添加
gene标志)--ensembl - :'correlation'(相关性,默认,返回100个相关性最高的基因)或'tissue'(组织表达图谱)
-w/--which - :'human'(人类,默认)或'mouse'(小鼠,仅组织数据可用)
-s/--species - :输入为Ensembl ID
-e/--ensembl
返回内容:
- 相关性模式:基因符号、皮尔逊相关系数
- 组织模式:组织标识符、最小值/四分位距1/中位数/四分位距3/最大值表达值
示例:
bash
undefinedGet correlated genes
获取相关基因
gget archs4 ACE2
gget archs4 ACE2
Get tissue expression
获取组织表达数据
gget archs4 -w tissue ACE2
```pythongget archs4 -w tissue ACE2
```pythonPython
Python
gget.archs4("ACE2", which="tissue")
undefinedgget.archs4("ACE2", which="tissue")
undefinedgget cellxgene - Single-Cell RNA-seq Data
gget cellxgene - 单细胞RNA-seq数据
Query CZ CELLxGENE Discover Census for single-cell data.
Setup Required:
bash
gget setup cellxgeneParameters:
- (-g): Gene names or Ensembl IDs (case-sensitive! 'PAX7' for human, 'Pax7' for mouse)
--gene - : Tissue type(s)
--tissue - : Specific cell type(s)
--cell_type - (-s): 'homo_sapiens' (default) or 'mus_musculus'
--species - (-cv): Version ("stable", "latest", or dated)
--census_version - (-e): Use Ensembl IDs
--ensembl - (-mo): Return metadata only
--meta_only - Additional filters: disease, development_stage, sex, assay, dataset_id, donor_id, ethnicity, suspension_type
Returns: AnnData object with count matrices and metadata (or metadata-only dataframes)
Examples:
bash
undefined查询CZ CELLxGENE Discover Census获取单细胞数据。
前置设置:
bash
gget setup cellxgene参数:
- (-g):基因名称或Ensembl ID(区分大小写!人类用'PAX7',小鼠用'Pax7')
--gene - :组织类型
--tissue - :特定细胞类型
--cell_type - (-s):'homo_sapiens'(人类,默认)或'mus_musculus'(小鼠)
--species - (-cv):版本("stable"、"latest"或日期格式)
--census_version - (-e):使用Ensembl ID
--ensembl - (-mo):仅返回元数据
--meta_only - 其他过滤参数:disease(疾病)、development_stage(发育阶段)、sex(性别)、assay(检测方法)、dataset_id(数据集ID)、donor_id(供体ID)、ethnicity(种族)、suspension_type(悬液类型)
返回内容:包含计数矩阵和元数据的AnnData对象(或仅元数据的DataFrame)
示例:
bash
undefinedGet 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
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
```pythongget cellxgene --gene PAX7 --tissue muscle --meta_only -o metadata.csv
```pythonPython
Python
adata = gget.cellxgene(gene=["ACE2", "ABCA1"], tissue="lung", cell_type="mucus secreting cell")
undefinedadata = gget.cellxgene(gene=["ACE2", "ABCA1"], tissue="lung", cell_type="mucus secreting cell")
undefinedgget enrichr - Enrichment Analysis
gget enrichr - 富集分析
Perform ontology enrichment analysis on gene lists using Enrichr.
Parameters:
- : Gene symbols or Ensembl IDs
genes - : Reference database (supports shortcuts: 'pathway', 'transcription', 'ontology', 'diseases_drugs', 'celltypes')
-db/--database - : human (default), mouse, fly, yeast, worm, fish
-s/--species - : Background genes for comparison
-bkg_l/--background_list - : Save KEGG pathway images with highlighted genes
-ko/--kegg_out - : Python-only; generate graphical results
plot
Database Shortcuts:
- 'pathway' → KEGG_2021_Human
- 'transcription' → ChEA_2016
- 'ontology' → GO_Biological_Process_2021
- 'diseases_drugs' → GWAS_Catalog_2019
- 'celltypes' → PanglaoDB_Augmented_2021
Examples:
bash
undefined使用Enrichr对基因列表进行本体富集分析。
参数:
- :基因符号或Ensembl ID
genes - :参考数据库(支持快捷方式:'pathway'、'transcription'、'ontology'、'diseases_drugs'、'celltypes')
-db/--database - :human(人类,默认)、mouse(小鼠)、fly(果蝇)、yeast(酵母)、worm(线虫)、fish(鱼类)
-s/--species - :用于比较的背景基因列表
-bkg_l/--background_list - :保存带有高亮基因的KEGG通路图像
-ko/--kegg_out - :仅Python可用;生成图形化结果
plot
数据库快捷方式:
- 'pathway' → KEGG_2021_Human
- 'transcription' → ChEA_2016
- 'ontology' → GO_Biological_Process_2021
- 'diseases_drugs' → GWAS_Catalog_2019
- 'celltypes' → PanglaoDB_Augmented_2021
示例:
bash
undefinedEnrichment analysis for ontology
进行本体富集分析
gget enrichr -db ontology ACE2 AGT AGTR1
gget enrichr -db ontology ACE2 AGT AGTR1
Save KEGG pathways
保存KEGG通路图像
gget enrichr -db pathway ACE2 AGT AGTR1 -ko ./kegg_images/
```pythongget enrichr -db pathway ACE2 AGT AGTR1 -ko ./kegg_images/
```pythonPython with plot
Python(带绘图)
gget.enrichr(["ACE2", "AGT", "AGTR1"], database="ontology", plot=True)
undefinedgget.enrichr(["ACE2", "AGT", "AGTR1"], database="ontology", plot=True)
undefinedgget bgee - Orthology & Expression
gget bgee - 同源性与表达
Retrieve orthology and gene expression data from Bgee database.
Parameters:
- : Ensembl gene ID or NCBI gene ID (for non-Ensembl species). Multiple IDs supported when
ens_idtype=expression - : 'orthologs' (default) or 'expression'
-t/--type
Returns:
- Orthologs mode: Matching genes across species with IDs, names, taxonomic info
- Expression mode: Anatomical entities, confidence scores, expression status
Examples:
bash
undefined从Bgee数据库获取同源性和基因表达数据。
参数:
- :Ensembl基因ID或NCBI基因ID(适用于非Ensembl物种)。当
ens_id时支持多个IDtype=expression - :'orthologs'(同源基因,默认)或'expression'(表达数据)
-t/--type
返回内容:
- 同源基因模式:跨物种的匹配基因及其ID、名称、分类信息
- 表达模式:解剖实体、置信度评分、表达状态
示例:
bash
undefinedGet orthologs
获取同源基因
gget bgee ENSG00000169194
gget bgee ENSG00000169194
Get expression data
获取表达数据
gget bgee ENSG00000169194 -t expression
gget bgee ENSG00000169194 -t expression
Multiple genes
多个基因
gget bgee ENSBTAG00000047356 ENSBTAG00000018317 -t expression
```pythongget bgee ENSBTAG00000047356 ENSBTAG00000018317 -t expression
```pythonPython
Python
gget.bgee("ENSG00000169194", type="orthologs")
undefinedgget.bgee("ENSG00000169194", type="orthologs")
undefinedgget opentargets - Disease & Drug Associations
gget opentargets - 疾病与药物关联
Retrieve disease and drug associations from OpenTargets.
Parameters:
- Ensembl gene ID (required)
- : diseases (default), drugs, tractability, pharmacogenetics, expression, depmap, interactions
-r/--resource - : Cap results count
-l/--limit - Filter arguments (vary by resource):
- drugs:
--filter_disease - pharmacogenetics:
--filter_drug - expression/depmap: ,
--filter_tissue,--filter_anat_sys--filter_organ - interactions: ,
--filter_protein_a,--filter_protein_b--filter_gene_b
- drugs:
Examples:
bash
undefined从OpenTargets获取疾病和药物关联数据。
参数:
- Ensembl基因ID(必填)
- :diseases(疾病,默认)、drugs(药物)、tractability(成药性)、pharmacogenetics(药物遗传学)、expression(表达)、depmap(癌症依赖性图谱)、interactions(相互作用)
-r/--resource - :结果数量上限
-l/--limit - 过滤参数(因资源而异):
- drugs:
--filter_disease - pharmacogenetics:
--filter_drug - expression/depmap:、
--filter_tissue、--filter_anat_sys--filter_organ - interactions:、
--filter_protein_a、--filter_protein_b--filter_gene_b
- drugs:
示例:
bash
undefinedGet associated diseases
获取相关疾病
gget opentargets ENSG00000169194 -r diseases -l 5
gget opentargets ENSG00000169194 -r diseases -l 5
Get associated drugs
获取相关药物
gget opentargets ENSG00000169194 -r drugs -l 10
gget opentargets ENSG00000169194 -r drugs -l 10
Get tissue expression
获取组织表达数据
gget opentargets ENSG00000169194 -r expression --filter_tissue brain
```pythongget opentargets ENSG00000169194 -r expression --filter_tissue brain
```pythonPython
Python
gget.opentargets("ENSG00000169194", resource="diseases", limit=5)
undefinedgget.opentargets("ENSG00000169194", resource="diseases", limit=5)
undefinedgget cbio - cBioPortal Cancer Genomics
gget cbio - cBioPortal癌症基因组学
Plot cancer genomics heatmaps using cBioPortal data.
Two subcommands:
search - Find study IDs:
bash
gget cbio search breast lungplot - Generate heatmaps:
Parameters:
- : Space-separated cBioPortal study IDs (required)
-s/--study_ids - : Space-separated gene names or Ensembl IDs (required)
-g/--genes - : Column to organize data (tissue, cancer_type, cancer_type_detailed, study_id, sample)
-st/--stratification - : Data type (mutation_occurrences, cna_nonbinary, sv_occurrences, cna_occurrences, Consequence)
-vt/--variation_type - : Filter by column value (e.g., 'study_id:msk_impact_2017')
-f/--filter - : Cache directory (default: ./gget_cbio_cache)
-dd/--data_dir - : Output directory (default: ./gget_cbio_figures)
-fd/--figure_dir - : Resolution (default: 100)
-dpi - : Display plot in window
-sh/--show - : Skip download confirmations
-nc/--no_confirm
Examples:
bash
undefined使用cBioPortal数据绘制癌症基因组学热图。
两个子命令:
search - 查找研究ID:
bash
gget cbio search breast lungplot - 生成热图:
参数:
- :空格分隔的cBioPortal研究ID(必填)
-s/--study_ids - :空格分隔的基因名称或Ensembl ID(必填)
-g/--genes - :用于组织数据的列(tissue、cancer_type、cancer_type_detailed、study_id、sample)
-st/--stratification - :数据类型(mutation_occurrences、cna_nonbinary、sv_occurrences、cna_occurrences、Consequence)
-vt/--variation_type - :按列值过滤(例如'study_id:msk_impact_2017')
-f/--filter - :缓存目录(默认:./gget_cbio_cache)
-dd/--data_dir - :输出目录(默认:./gget_cbio_figures)
-fd/--figure_dir - :分辨率(默认:100)
-dpi - :在窗口中显示绘图
-sh/--show - :跳过下载确认
-nc/--no_confirm
示例:
bash
undefinedSearch for studies
搜索研究
gget cbio search esophag ovary
gget cbio search esophag ovary
Create heatmap
创建热图
gget cbio plot -s msk_impact_2017 -g AKT1 ALK BRAF -st tissue -vt mutation_occurrences
```pythongget cbio plot -s msk_impact_2017 -g AKT1 ALK BRAF -st tissue -vt mutation_occurrences
```pythonPython
Python
gget.cbio_search(["esophag", "ovary"])
gget.cbio_plot(["msk_impact_2017"], ["AKT1", "ALK"], stratification="tissue")
undefinedgget.cbio_search(["esophag", "ovary"])
gget.cbio_plot(["msk_impact_2017"], ["AKT1", "ALK"], stratification="tissue")
undefinedgget cosmic - COSMIC Database
gget cosmic - COSMIC数据库
Search COSMIC (Catalogue Of Somatic Mutations In Cancer) database.
Important: License fees apply for commercial use. Requires COSMIC account credentials.
Parameters:
- : Gene name, Ensembl ID, mutation notation, or sample ID
searchterm - : Path to downloaded COSMIC TSV file (required for querying)
-ctp/--cosmic_tsv_path - : Maximum results (default: 100)
-l/--limit
Database download flags:
- : Activate download mode
-d/--download_cosmic - : Create version for gget mutate
-gm/--gget_mutate - : Database type (cancer, census, cell_line, resistance, genome_screen, targeted_screen)
-cp/--cosmic_project - : COSMIC version
-cv/--cosmic_version - : Human reference genome (37 or 38)
-gv/--grch_version - ,
--email: COSMIC credentials--password
Examples:
bash
undefined搜索COSMIC(癌症体细胞突变目录)数据库。
重要提示:商业使用需支付许可费。需要COSMIC账户凭据。
参数:
- :基因名称、Ensembl ID、突变符号或样本ID
searchterm - :下载的COSMIC TSV文件路径(查询必填)
-ctp/--cosmic_tsv_path - :最大结果数(默认:100)
-l/--limit
数据库下载标志:
- :激活下载模式
-d/--download_cosmic - :创建适用于gget mutate的版本
-gm/--gget_mutate - :数据库类型(cancer、census、cell_line、resistance、genome_screen、targeted_screen)
-cp/--cosmic_project - :COSMIC版本
-cv/--cosmic_version - :人类参考基因组(37或38)
-gv/--grch_version - ,
--email:COSMIC账户凭据--password
示例:
bash
undefinedFirst download database
先下载数据库
gget cosmic -d --email user@example.com --password xxx -cp cancer
gget cosmic -d --email user@example.com --password xxx -cp cancer
Then query
然后进行查询
gget cosmic EGFR -ctp cosmic_data.tsv -l 10
```pythongget cosmic EGFR -ctp cosmic_data.tsv -l 10
```pythonPython
Python
gget.cosmic("EGFR", cosmic_tsv_path="cosmic_data.tsv", limit=10)
undefinedgget.cosmic("EGFR", cosmic_tsv_path="cosmic_data.tsv", limit=10)
undefined5. Additional Tools
5. 附加工具
gget mutate - Generate Mutated Sequences
gget mutate - 生成突变序列
Generate mutated nucleotide sequences from mutation annotations.
Parameters:
- : FASTA file path or direct sequence input (string/list)
sequences - : CSV/TSV file or DataFrame with mutation data (required)
-m/--mutations - : Mutation column name (default: 'mutation')
-mc/--mut_column - : Sequence ID column (default: 'seq_ID')
-sic/--seq_id_column - : Mutation ID column
-mic/--mut_id_column - : Length of flanking sequences (default: 30 nucleotides)
-k/--k
Returns: Mutated sequences in FASTA format
Examples:
bash
undefined根据突变注释生成突变后的核苷酸序列。
参数:
- :FASTA文件路径或直接输入序列(字符串/列表)
sequences - :包含突变数据的CSV/TSV文件或DataFrame(必填)
-m/--mutations - :突变列名称(默认:'mutation')
-mc/--mut_column - :序列ID列(默认:'seq_ID')
-sic/--seq_id_column - :突变ID列
-mic/--mut_id_column - :侧翼序列长度(默认:30个核苷酸)
-k/--k
返回内容:FASTA格式的突变序列
示例:
bash
undefinedSingle mutation
单个突变
gget mutate ATCGCTAAGCT -m "c.4G>T"
gget mutate ATCGCTAAGCT -m "c.4G>T"
Multiple sequences with mutations from file
多个序列与文件中的突变数据
gget mutate sequences.fasta -m mutations.csv -o mutated.fasta
```pythongget mutate sequences.fasta -m mutations.csv -o mutated.fasta
```pythonPython
Python
import pandas as pd
mutations_df = pd.DataFrame({"seq_ID": ["seq1"], "mutation": ["c.4G>T"]})
gget.mutate(["ATCGCTAAGCT"], mutations=mutations_df)
undefinedimport pandas as pd
mutations_df = pd.DataFrame({"seq_ID": ["seq1"], "mutation": ["c.4G>T"]})
gget.mutate(["ATCGCTAAGCT"], mutations=mutations_df)
undefinedgget gpt - OpenAI Text Generation
gget gpt - OpenAI文本生成
Generate natural language text using OpenAI's API.
Setup Required:
bash
gget setup gptImportant: Free tier limited to 3 months after account creation. Set monthly billing limits.
Parameters:
- : Text input for generation (required)
prompt - : OpenAI authentication (required)
api_key - Model configuration: temperature, top_p, max_tokens, frequency_penalty, presence_penalty
- Default model: gpt-3.5-turbo (configurable)
Examples:
bash
gget gpt "Explain CRISPR" --api_key your_key_herepython
undefined使用OpenAI的API生成自然语言文本。
前置设置:
bash
gget setup gpt重要提示:免费版在账户创建后3个月内可用。请设置每月账单限额。
参数:
- :用于生成的文本输入(必填)
prompt - :OpenAI认证密钥(必填)
api_key - 模型配置:temperature、top_p、max_tokens、frequency_penalty、presence_penalty
- 默认模型:gpt-3.5-turbo(可配置)
示例:
bash
gget gpt "Explain CRISPR" --api_key your_key_herepython
undefinedPython
Python
gget.gpt("Explain CRISPR", api_key="your_key_here")
undefinedgget.gpt("Explain CRISPR", api_key="your_key_here")
undefinedgget setup - Install Dependencies
gget setup - 安装依赖
Install/download third-party dependencies for specific modules.
Parameters:
- : Module name requiring dependency installation
module - : Output folder path (elm module only)
-o/--out
Modules requiring setup:
- - Downloads ~4GB of model parameters
alphafold - - Installs cellxgene-census (may not support latest Python)
cellxgene - - Downloads local ELM database
elm - - Configures OpenAI integration
gpt
Examples:
bash
undefined为特定模块安装/下载第三方依赖。
参数:
- :需要安装依赖的模块名称
module - :输出文件夹路径(仅elm模块可用)
-o/--out
需要设置的模块:
- - 下载约4GB的模型参数
alphafold - - 安装cellxgene-census(可能不支持最新Python版本)
cellxgene - - 下载本地ELM数据库
elm - - 配置OpenAI集成
gpt
示例:
bash
undefinedSetup AlphaFold
设置AlphaFold
gget setup alphafold
gget setup alphafold
Setup ELM with custom directory
设置ELM并指定自定义目录
gget setup elm -o /path/to/elm_data
```pythongget setup elm -o /path/to/elm_data
```pythonPython
Python
gget.setup("alphafold")
undefinedgget.setup("alphafold")
undefinedCommon Workflows
常见工作流
Workflow 1: Gene Discovery to Sequence Analysis
工作流1:基因发现到序列分析
Find and analyze genes of interest:
python
undefined查找并分析目标基因:
python
undefined1. Search for genes
1. 搜索基因
results = gget.search(["GABA", "receptor"], species="homo_sapiens")
results = gget.search(["GABA", "receptor"], species="homo_sapiens")
2. Get detailed information
2. 获取详细信息
gene_ids = results["ensembl_id"].tolist()
info = gget.info(gene_ids[:5])
gene_ids = results["ensembl_id"].tolist()
info = gget.info(gene_ids[:5])
3. Retrieve sequences
3. 检索序列
sequences = gget.seq(gene_ids[:5], translate=True)
undefinedsequences = gget.seq(gene_ids[:5], translate=True)
undefinedWorkflow 2: Sequence Alignment and Structure
工作流2:序列比对与结构预测
Align sequences and predict structures:
python
undefined比对序列并预测结构:
python
undefined1. Align multiple sequences
1. 比对多个序列
alignment = gget.muscle("sequences.fasta")
alignment = gget.muscle("sequences.fasta")
2. Find similar sequences
2. 查找相似序列
blast_results = gget.blast(my_sequence, database="swissprot", limit=10)
blast_results = gget.blast(my_sequence, database="swissprot", limit=10)
3. Predict structure
3. 预测结构
structure = gget.alphafold(my_sequence, plot=True)
structure = gget.alphafold(my_sequence, plot=True)
4. Find linear motifs
4. 查找线性基序
ortholog_df, regex_df = gget.elm(my_sequence)
undefinedortholog_df, regex_df = gget.elm(my_sequence)
undefinedWorkflow 3: Gene Expression and Enrichment
工作流3:基因表达与富集分析
Analyze expression patterns and functional enrichment:
python
undefined分析表达模式和功能富集:
python
undefined1. Get tissue expression
1. 获取组织表达数据
tissue_expr = gget.archs4("ACE2", which="tissue")
tissue_expr = gget.archs4("ACE2", which="tissue")
2. Find correlated genes
2. 查找相关基因
correlated = gget.archs4("ACE2", which="correlation")
correlated = gget.archs4("ACE2", which="correlation")
3. Get single-cell data
3. 获取单细胞数据
adata = gget.cellxgene(gene=["ACE2"], tissue="lung", cell_type="epithelial cell")
adata = gget.cellxgene(gene=["ACE2"], tissue="lung", cell_type="epithelial cell")
4. Perform enrichment analysis
4. 进行富集分析
gene_list = correlated["gene_symbol"].tolist()[:50]
enrichment = gget.enrichr(gene_list, database="ontology", plot=True)
undefinedgene_list = correlated["gene_symbol"].tolist()[:50]
enrichment = gget.enrichr(gene_list, database="ontology", plot=True)
undefinedWorkflow 4: Disease and Drug Analysis
工作流4:疾病与药物分析
Investigate disease associations and therapeutic targets:
python
undefined研究疾病关联和治疗靶点:
python
undefined1. Search for genes
1. 搜索基因
genes = gget.search(["breast cancer"], species="homo_sapiens")
genes = gget.search(["breast cancer"], species="homo_sapiens")
2. Get disease associations
2. 获取疾病关联数据
diseases = gget.opentargets("ENSG00000169194", resource="diseases")
diseases = gget.opentargets("ENSG00000169194", resource="diseases")
3. Get drug associations
3. 获取药物关联数据
drugs = gget.opentargets("ENSG00000169194", resource="drugs")
drugs = gget.opentargets("ENSG00000169194", resource="drugs")
4. Query cancer genomics data
4. 查询癌症基因组学数据
study_ids = gget.cbio_search(["breast"])
gget.cbio_plot(study_ids[:2], ["BRCA1", "BRCA2"], stratification="cancer_type")
study_ids = gget.cbio_search(["breast"])
gget.cbio_plot(study_ids[:2], ["BRCA1", "BRCA2"], stratification="cancer_type")
5. Search COSMIC for mutations
5. 在COSMIC中搜索突变
cosmic_results = gget.cosmic("BRCA1", cosmic_tsv_path="cosmic.tsv")
undefinedcosmic_results = gget.cosmic("BRCA1", cosmic_tsv_path="cosmic.tsv")
undefinedWorkflow 5: Comparative Genomics
工作流5:比较基因组学
Compare proteins across species:
python
undefined跨物种比较蛋白质:
python
undefined1. Get orthologs
1. 获取同源基因
orthologs = gget.bgee("ENSG00000169194", type="orthologs")
orthologs = gget.bgee("ENSG00000169194", type="orthologs")
2. Get sequences for comparison
2. 获取用于比较的序列
human_seq = gget.seq("ENSG00000169194", translate=True)
mouse_seq = gget.seq("ENSMUSG00000026091", translate=True)
human_seq = gget.seq("ENSG00000169194", translate=True)
mouse_seq = gget.seq("ENSMUSG00000026091", translate=True)
3. Align sequences
3. 比对序列
alignment = gget.muscle([human_seq, mouse_seq])
alignment = gget.muscle([human_seq, mouse_seq])
4. Compare structures
4. 比较结构
human_structure = gget.pdb("7S7U")
mouse_structure = gget.alphafold(mouse_seq)
undefinedhuman_structure = gget.pdb("7S7U")
mouse_structure = gget.alphafold(mouse_seq)
undefinedWorkflow 6: Building Reference Indices
工作流6:构建参考索引
Prepare reference data for downstream analysis (e.g., kallisto|bustools):
bash
undefined为下游分析准备参考数据(例如kallisto|bustools):
bash
undefined1. List available species
1. 列出可用物种
gget ref --list_species
gget ref --list_species
2. Download reference files
2. 下载参考文件
gget ref -w gtf -w cdna -d homo_sapiens
gget ref -w gtf -w cdna -d homo_sapiens
3. Build kallisto index
3. 构建kallisto索引
kallisto index -i transcriptome.idx transcriptome.fasta
kallisto index -i transcriptome.idx transcriptome.fasta
4. Download genome for alignment
4. 下载用于比对的基因组
gget ref -w dna -d homo_sapiens
undefinedgget ref -w dna -d homo_sapiens
undefinedBest Practices
最佳实践
Data Retrieval
数据检索
- Use to control result sizes for large queries
--limit - Save results with for reproducibility
-o/--out - Check database versions/releases for consistency across analyses
- Use in production scripts to reduce output
--quiet
- 使用控制大型查询的结果数量
--limit - 使用保存结果以保证可重复性
-o/--out - 检查数据库版本/发布版本以确保分析的一致性
- 在生产脚本中使用减少输出
--quiet
Sequence Analysis
序列分析
- For BLAST/BLAT, start with default parameters, then adjust sensitivity
- Use with
gget diamondfor faster local alignment--threads - Save DIAMOND databases with for repeated queries
--diamond_db - For multiple sequence alignment, use for large datasets
-s5/--super5
- 对于BLAST/BLAT,先使用默认参数,再调整灵敏度
- 使用并添加
gget diamond以加快局部比对速度--threads - 使用保存DIAMOND数据库以供重复查询
--diamond_db - 对于多序列比对,对大型数据集使用
-s5/--super5
Expression and Disease Data
表达与疾病数据
- Gene symbols are case-sensitive in cellxgene (e.g., 'PAX7' vs 'Pax7')
- Run before first use of alphafold, cellxgene, elm, gpt
gget setup - For enrichment analysis, use database shortcuts for convenience
- Cache cBioPortal data with to avoid repeated downloads
-dd
- cellxgene中的基因符号区分大小写(例如'PAX7' vs 'Pax7')
- 首次使用alphafold、cellxgene、elm、gpt前先运行
gget setup - 富集分析中使用数据库快捷方式以简化操作
- 使用缓存cBioPortal数据以避免重复下载
-dd
Structure Prediction
结构预测
- AlphaFold multimer predictions: use for higher accuracy
-mr 20 - Use flag for AMBER relaxation of final structures
-r - Visualize results in Python with
plot=True - Check PDB database first before running AlphaFold predictions
- AlphaFold多聚体预测:使用以提高准确性
-mr 20 - 使用标志对最终结构进行AMBER松弛处理
-r - 在Python中使用可视化结果
plot=True - 运行AlphaFold预测前先检查PDB数据库
Error Handling
错误处理
- Database structures change; update gget regularly:
uv pip install --upgrade gget - Process max ~1000 Ensembl IDs at once with gget info
- For large-scale analyses, implement rate limiting for API queries
- Use virtual environments to avoid dependency conflicts
- 数据库结构会变化;定期更新gget:
uv pip install --upgrade gget - 使用gget info时一次最多处理约1000个Ensembl ID
- 对于大规模分析,为API查询实现速率限制
- 使用虚拟环境避免依赖冲突
Output Formats
输出格式
Command-line
命令行
- Default: JSON
- CSV: Add flag
-csv - FASTA: gget seq, gget mutate
- PDB: gget pdb, gget alphafold
- PNG: gget cbio plot
- 默认:JSON
- CSV:添加标志
-csv - FASTA:gget seq、gget mutate
- PDB:gget pdb、gget alphafold
- PNG:gget cbio plot
Python
Python
- Default: DataFrame or dictionary
- JSON: Add parameter
json=True - Save to file: Add or specify
save=Trueout="filename" - AnnData: gget cellxgene
- 默认:DataFrame或字典
- JSON:添加参数
json=True - 保存到文件:添加或指定
save=Trueout="filename" - AnnData:gget cellxgene
Resources
资源
This skill includes reference documentation for detailed module information:
本工具包含参考文档以获取模块的详细信息:
references/
references/
- - Comprehensive parameter reference for all modules
module_reference.md - - Information about queried databases and their update frequencies
database_info.md - - Extended workflow examples and use cases
workflows.md
For additional help:
- Official documentation: https://pachterlab.github.io/gget/
- GitHub issues: https://github.com/pachterlab/gget/issues
- Citation: Luebbert, L. & Pachter, L. (2023). Efficient querying of genomic reference databases with gget. Bioinformatics. https://doi.org/10.1093/bioinformatics/btac836
- - 所有模块的综合参数参考
module_reference.md - - 查询的数据库及其更新频率信息
database_info.md - - 扩展工作流示例和用例
workflows.md
如需更多帮助:
- 官方文档:https://pachterlab.github.io/gget/
- GitHub问题:https://github.com/pachterlab/gget/issues
- 引用文献:Luebbert, L. & Pachter, L. (2023). Efficient querying of genomic reference databases with gget. Bioinformatics. https://doi.org/10.1093/bioinformatics/btac836