module_reference

# gget 模块参考 所有 gget 模块的综合参数参考。 ## 参考与基因信息模块 ### gget ref 检索 Ensembl 参考基因组 FTP 和元数据。 **参数：** | 参数 | 类型 | 描述 | 默认值 | |-----------|------|-------------|---------| | `species` | str | Genus_species 格式的物种或快捷方式 ('human', 'mouse') | 必需 | | `-w/--which` | str | 要返回的文件类型：gtf, cdna, dna, cds, cdrna, pep | 全部 | | `-r/--release` | int | Ensembl 发布版本号 | 最新 | | `-od/--out_dir` | str | 输出目录路径 | 无 | | `-o/--out` | str | 结果的 JSON 文件路径 | 无 | | `-l/--list_species` | flag | 列出可用的脊椎动物物种 | False | | `-liv/--list_iv_species` | flag | 列出可用的无脊椎动物物种 | False | | `-ftp` | flag | 仅返回 FTP 链接 | False | | `-d/--download` | flag | 下载文件（需要 curl） | False | | `-q/--quiet` | flag | 抑制进度信息 | False | **返回：** 包含 FTP 链接、Ensembl 发布版本号、发布日期、文件大小的 JSON --- ### gget search 在 Ensembl 中按名称或描述搜索基因。 **参数：** | 参数 | 类型 | 描述 | 默认值 | |-----------|------|-------------|---------| | `searchwords` | str/list | 搜索词（不区分大小写） | 必需 | | `-s/--species` | str | 目标物种或核心数据库名称 | 必需 | | `-r/--release` | int | Ensembl 发布版本号 | 最新 | | `-t/--id_type` | str | 返回 'gene' 或 'transcript' | 'gene' | | `-ao/--andor` | str | 'or' (任意词) 或 'and' (所有词) | 'or' | | `-l/--limit` | int | 返回的最大结果数 | 无 | | `-o/--out` | str | 输出文件路径 (CSV/JSON) | 无 | **返回：** ensembl_id, gene_name, ensembl_description, ext_ref_description, biotype, URL --- ### gget info 从 Ensembl、UniProt 和 NCBI 获取全面的基因/转录本元数据。 **参数：** | 参数 | 类型 | 描述 | 默认值 | |-----------|------|-------------|---------| | `ens_ids` | str/list | Ensembl ID (也支持 WormBase, Flybase) | 必需 | | `-o/--out` | str | 输出文件路径 (CSV/JSON) | 无 | | `-n/--ncbi` | bool | 禁用 NCBI 数据检索 | False | | `-u/--uniprot` | bool | 禁用 UniProt 数据检索 | False | | `-pdb` | bool | 包含 PDB 标识符 | False | | `-csv` | flag | 返回 CSV 格式 (CLI) | False | | `-q/--quiet` | flag | 抑制进度显示 | False | **Python 特有：** - `save=True`: 保存输出