pySCENIC 是通过python实现的一个快速的 SCENIC pipeline,pySCENIC支持多线程运行,如果你的设备条件慢足的话,可以大大的节省我们的运算时间。( 可查看SCENIC用法 ,SCENIC是一种基于单细胞RNA-seq数据推断基因调控网络及其相关细胞状态的工具),进而从单细胞RNA-seq数据推断的出转录因子、基因调控网络和细胞类型。
1.安装和使用
1.1安装
1.1.1安装稳定的版本
软件包 最新稳定版本可以通过以下方式安装:
pip install pyscenic
请注意,如果想在一个新的 conda 环境中运行,pySCENIC 需要先安装一些额外的包。例如:pip install
conda create -y -n pyscenic python=3.7
conda activate pyscenic
conda install -y numpy
conda install -y -c anaconda cytoolz
pip install pyscenic
pySCENIC需要python 3.6以上版本解释器。
1.1.2 安装发展版本
直接从源代码安装包的最新版本(一般不太稳定,但可以使用最新的功能):
git clone https://github.com/aertslab/pySCENIC.git
cd pySCENIC/
pip install .
1.2 通过docker容器安装
pySCENIC 容器可以直接下载和使用。在这种情况下,不需要编译或安装,只要用户系统上安装了 Docker软件。镜像可从Docker Hub 获得。容器的使用如下所示(Docker Images)。首先获取docker 镜像,例如:
docker pull aertslab/pyscenic:0.10.0
1.3 下载辅助数据集
要想成功使用此管道,需要下载对应的辅助数据集:
数据库 根据调节特征(即转录因子)对您感兴趣的物种的整个 基因组 进行 排名。排名数据库通常以feather格式存储,可以从cisTargetDBs下载。
Motif注释 数据库提供了丰富的motif 和结合该motif的转录因子之间的缺失链接。该pipeline需要一个 TSV 文本文件,其中每一行都代表一个特定的注释。
注意:这些数据库每个都是 1.1 Gb,因此下载可能需要一段时间。注释文件的大小通常为 100Mb。
在执行网络推理步骤时(GENIE3/GRNBoost2) 需要转录因子列表。可以从GitHub资源下载。
1.4 命令行界面
包括该工具的命令行版本。通过pip
.
$ pyscenic -h
usage: pyscenic [-h] {grn,add_cor,ctx,aucell} ...
Single-CEll regulatory Network Inference and Clustering (0.11.0)
positional arguments:
{grn,add_cor,ctx,aucell}
sub-command help
grn Derive co-expression modules from expression matrix.
add_cor [Optional] Add Pearson correlations based on TF-gene
expression to the network adjacencies output from the
GRN step, and output these to a new adjacencies file.
This will normally be done during the "ctx" step.
ctx Find enriched motifs for a gene signature and
optionally prune targets from this signature based on
cis-regulatory cues.
aucell Quantify activity of gene signatures across single
cells.
optional arguments:
-h, --help show this help message and exit
Arguments can be read from file using a @args.txt construct. For more
information on loom file format see http://loompy.org . For more information
on gmt file format see https://software.broadinstitute.org/cancer/software/gse
a/wiki/index.php/Data_formats .
Docker镜像
pySCENIC 可用于Docker,Docker容器中的命令使用类似于命令行界面的使用方法。请注意,容器需要通过安装访问feather数据库、转录因子和主题注释数据库。在下面的示例中,为简单起见:将下载的辅助数据集所在的目录/data
安装到容器目录/data
下,其中将包含输入、输出和数据库文件。
想了解其它更多的使用示例,请参阅与SCENIC 协议 Nextflow 相关的文档。
docker
Docker 镜像可以从Docker Hub 获取,可以通过运行获取,version标签为最新版本。docker pull aertslab/pyscenic:[version]
要使用 Docker 运行 pySCENIC,一般需要三个步骤。并指定一个挂载点(或多个),其中包含输入数据和必要的资源。
docker run -it --rm \
-v /data:/data \
aertslab/pyscenic:0.10.0 pyscenic grn \
--num_workers 6 \
-o /data/expr_mat.adjacencies.tsv \
/data/expr_mat.tsv \
/data/allTFs_hg38.txt
docker run -it --rm \
-v /data:/data \
aertslab/pyscenic:0.10.0 pyscenic ctx \
/data/expr_mat.adjacencies.tsv \
/data/hg19-tss-centered-5kb-7species.mc9nr.feather \
/data/hg19-tss-centered-10kb-7species.mc9nr.feather \
--annotations_fname /data/motifs-v9-nr.hgnc-m0.001-o0.0.tbl \
--expression_mtx_fname /data/expr_mat.tsv \
--mode "dask_multiprocessing" \
--output /data/regulons.csv \
--num_workers 6
docker run -it --rm \
-v /data:/data \
aertslab/pyscenic:0.10.0 pyscenic aucell \
/data/expr_mat.tsv \
/data/regulons.csv \
-o /data/auc_mtx.csv \