GPAS平台的命令行和Python客户端
项目描述
GPAS客户端
GPAS结核分枝杆菌平台的命令行界面。客户端可以保护隐私地提交序列数据，并检索分析输出文件。在上传之前，样本标识符将被匿名化，并删除人类宿主序列。建议使用16GB RAM的Linux或MacOS的多核机器。
安装
安装Miniconda
如果已经安装了conda包管理器，请跳转到安装客户端，否则
Linux
- 在终端控制台中，按照说明安装Miniconda，接受默认选项
curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh bash Miniconda3-latest-Linux-x86_64.sh
MacOS
客户端需要一个x86_64的conda安装。如果您的Mac有Apple处理器，请在继续之前禁用或删除现有的arm64conda安装。
- 如果您的Mac有Apple处理器，请使用Terminal，首先运行
arch -x86_64 zsh
- 使用Terminal安装Miniconda，按照说明并接受默认选项
curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh bash Miniconda3-latest-MacOSX-x86_64.sh
安装或更新客户端
-
如果使用Apple处理器的Mac，请使用Terminal，首先运行
arch -x86_64 zsh
-
执行安装/升级
conda create -y -n gpas -c conda-forge -c bioconda hostile==1.1.0 conda activate gpas pip install --upgrade gpas
-
测试
gpas --version
Tab补全
可以通过将以下行添加到您的shell源文件中，选择性地启用Tab补全。这将启用在写入gpas 后按Tab键列出可能子命令的功能。如果在按Tab键之前输入了--，它也可以用于子命令选项。
示例用法
启用Tab补全
运行以下命令并按照输出启用自动补全，这需要在每次新的shell会话中执行，将根据您的环境提供如何使其永久生效的说明。更多信息和其他shell的说明可以在Click文档中找到。
$ gpas autocomplete
Run this command to enable autocompletion:
eval "$(_GPAS_COMPLETE=zsh_source gpas)"
Add this to your ~/.zshrc file to enable this permanently:
command -v gpas > /dev/null 2>&1 && eval "$(_GPAS_COMPLETE=zsh_source gpas)"
用法
确保conda环境已激活
conda activate gpas
帮助
运行gpas --help查看CLI子命令概述。对于特定子命令的帮助，使用例如gpas auth --help。
身份验证（gpas auth）
您第一次使用客户端时需要认证。通过运行gpas auth并输入用户名和密码来完成此操作。令牌将自动保存在您的家目录中。
gpas auth
Enter your username: bede.constantinides@ndm.ox.ac.uk
Enter your password: ***************
上传样本（gpas upload）
上传子命令对每个样本执行元数据验证和客户端端人类读数的删除，然后将序列上传到GPAS平台进行分析。
gpas upload tests/data/illumina.csv
在上传过程中，将创建一个映射CSV文件（例如a5w2e8.mapping.csv），将您的本地样本名称与随机生成的远程名称链接起来。请妥善保管此文件，因为它在以后下载和重新链接结果时很有用。
第一次运行gpas upload时，将下载4GB的人类基因组索引。如果由于任何原因此过程被中断，只需再次运行上传命令。上传将在索引已下载并通过完整性检查后继续。您可以使用gpas download-index命令提前下载索引。
要保留上传到GPAS的净化过的FASTQ文件，请包含可选的--save标志。要执行净化而不上传任何内容，请使用可选的--dry-run标志。
添加--skip-fastq-check标志将阻止对FASTQ文件内容的基线有效性检查，从而节省时间。
下载文件（gpas download）
下载子命令可以根据上传过程中生成的映射CSV文件或一个或多个样本GUID来检索与一组样本关联的输出（和/或输入）文件。当使用映射CSV文件时，默认情况下下载的文件名以上传时提供的样本名称为前缀。否则，下载的文件以前缀的样本GUID开头。
# Download the main reports for all samples in a5w2e8.mapping.csv
gpas download a5w2e8.mapping.csv
# Download the main and speciation reports for all samples in a5w2e8.mapping.csv
gpas download a5w2e8.mapping.csv --filenames main_report.json,speciation_report.json
# Download the main report for one sample
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6
# Download the final assembly for one M. tuberculosis sample
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6 --filenames final.fasta
# Download the main report for two samples
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6,6f004868-096b-4587-9d50-b13e09d01882
# Save downloaded files to a specific directory
gpas download a5w2e8.mapping.csv --out-dir results
# Download only input fastqs
gpas download a5w2e8.mapping.csv --inputs --filenames ""
可下载的--filenames完整列表因样本而异，可在GPAS网络门户中样本查看页面的下载部分找到。
生成上传CSV（gpas build-csv）
如果您有一个包含您想上传的所有读取的文件夹，则可以使用gpas build-csv来帮助生成上传csv。请参阅GPAS用户指南，了解所有字段的详细描述。您需要填写一些必需的参数。
gpas build-csv --output-csv upload.csv --batch-name test_batch --collection-date 2024-04-15 --country GBR --max-batch-size 25 my_folder
然后您可以遍历csv，手动将样本标记为阳性/阴性对照，或给它们命名样本（默认情况下，它们根据文件名命名）。
查询样本元数据（gpas query）
查询子命令根据上传过程中生成的映射CSV文件或一个或多个样本GUID，获取一个或多个样本的处理状态（gpas query status）或原始元数据（gpas query raw）。
# Query the processing status of all samples in a5w2e8.mapping.csv
gpas query status a5w2e8.mapping.csv
# Query the processing status of a single sample
gpas query status 3bf7d6f9-c883-4273-adc0-93bb96a499f6
# Query all available metadata in JSON format
gpas query raw a5w2e8.mapping.csv
下载脱污索引（gpas download-index）
在首次运行gpas upload进行宿主脱污时，会自动下载用于宿主脱污的人类基因组索引。您可以使用gpas download-index手动触发此操作。
支持
如需技术支持，请提交问题或联系support@gpas.global
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装软件包的更多信息。
源分布
构建版本
gpas-1.0.3.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 7bed332204479b404035bac7785c09588bcfe4b975ced97479d033fd287d5d8e |
|
| MD5 | b55518d3d0a318c087a1568e7aa5debb |
|
| BLAKE2b-256 | b538e47919ba3402759df1f096f826957c200f83dbc731eabe21b5433b08e2f2 |
gpas-1.0.3-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | eef88a365921afbaaa56da5ce499ea564166fb391b5f52af5a144ec4e5ffb53c |
|
| MD5 | a04d38757ad00fa4a7fe11755824aeed |
|
| BLAKE2b-256 | 849f8f633b58e62f11f3292588a9096e9783b3a4535f9596830fd6a6681b5b6f |