结构变异查询：参数与补充说明

用法和示例见功能教程。

各功能按作用、API、输入、输出、示例代码和结果说明介绍。运行前按说明准备凭据、本地文件与可选依赖；远程结果随数据库版本与查询时间变化。

各功能按作用、API、输入、输出、示例代码和结果说明介绍。运行前按说明准备凭据、本地文件与可选依赖；远程结果随数据库版本与查询时间变化。

查询 Ensembl 区间内的结构变异

dnakit.databases.ensembl_get_structural_variants(*, species, region=None, feature=None, chrom=None, start=None, end=None, verbose=True)

参数	类型	必填 / 默认值	说明与约束
species	string	必填	Species name (e.g., 'human', 'homo_sapiens').
region	string	None	Genomic region in format 'chr:start-end' (e.g., '17:43044295-43125370'). Maximum 5Mb.
feature	string	None	Feature type to retrieve. Fixed to 'structural_variation' for this tool.
chrom	string	None	染色体标识；须与 start、end 一起传入。
start	integer	None	区域起点；本参数分支使用 Ensembl 的 1-based 闭区间。
end	integer	None	区域终点；本参数分支使用 Ensembl 的 1-based 闭区间。
verbose	bool	True	运行提示开关。

查询 Ensembl 结构变异详情

dnakit.databases.ensembl_get_sv_detail(*, species, id=None, sv_id=None, verbose=True)

参数	类型	必填 / 默认值	说明与约束
species	string	必填	Species name (e.g., 'human', 'homo_sapiens').
id	string	None	Structural variant accession from Ensembl/DGVa (e.g., 'nsv2769779', 'esv3647486'). Use ensembl_get_structural_variants to find IDs.
sv_id	string	None	DNAKit optional alias for id
verbose	bool	True	运行提示开关。

按基因查询 gnomAD 结构变异

dnakit.databases.gnomad_get_sv_by_gene(*, gene_symbol, reference_genome=None, verbose=True)

参数	类型	必填 / 默认值	说明与约束
gene_symbol	string	必填	Gene symbol (e.g., 'BRCA1', 'TP53', 'MECP2')
reference_genome	string	None	Reference genome assembly.
verbose	bool	True	运行提示开关。

按基因组区间查询 gnomAD 结构变异

dnakit.databases.gnomad_get_sv_by_region(*, chrom, start, stop=None, reference_genome=None, end=None, verbose=True)

参数	类型	必填 / 默认值	说明与约束
chrom	string	必填	Chromosome (e.g., '17', 'X').
start	integer	必填	Start position (1-based, GRCh38 by default).
stop	integer	None	Stop position.
reference_genome	string	None	Reference genome assembly.
end	integer	None	DNAKit optional alias for stop
verbose	bool	True	运行提示开关。

查询 gnomAD 结构变异详情

dnakit.databases.gnomad_get_sv_detail(*, variant_id=None, dataset=None, sv_id=None, verbose=True)

参数	类型	必填 / 默认值	说明与约束
variant_id	string	None	gnomAD structural variant ID. GRCh38/v4 IDs look like 'DEL_chr17_24e4872b'; GRCh37/v2.1 IDs look like 'DEL_1_1937'.
dataset	string	None	Optional SV callset override. Defaults to the callset auto-detected from the variant ID format (gnomad_sv_r2_1 for GRCh37-style IDs, gnomad_sv_r4 otherwise). Set explicitly only to query a v2.1 subset such as gnomad_sv_r2_1_controls.
sv_id	string	None	DNAKit optional alias for variant_id
verbose	bool	True	运行提示开关。