使用¶

示例数据

示例的样本数据存储于 Open Science Framework.

目前已经上传SCOPEv2样本数据, SCOPEv1样本数据, 其余类型样本TENX(10X), dropseq, indrop, BD Rhapsody待测试上传.

快速使用

scope run \
    --fq1 ./rawdata/R2005073_L1_1.fq.gz \
    --fq2 ./rawdata/R2005073_L1_2.fq.gz \
    --outdir ./ \
    --bctype SCOPEv2 \
    --annot ./references/Homo_sapiens/Ensembl/GRCh38/Homo_sapiens.GRCh38.99.gtf \
    --refFlat ./references/Homo_sapiens/Ensembl/GRCh38/Homo_sapiens.GRCh38.99.refFlat \
    --genomeDir ./references/Homo_sapiens/Ensembl/GRCh38
    --sample samplename
参数说明

–fq1：read1 fastq文件路径

–fq2：read2 fastq文件路径

–outdir: 输出路径

–bctype: 预置的接头类型

–annot: 基因组注释文件, gtf格式

–refFlat: refFlat文件路径

–genomeDir: 参考基因组路径, 包含STAR所建索引

–sample: 样本名称

示例报告

输出文件

使用说明
SCOPE-tools包含7个子命令, 分别是sample, barcode, cutadapt, STAR, featureCounts, count, cluster和run.
scope -h Usage: scope [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]... Single Cell Omics Preparation Entity Tools Options: --version Show the version and exit. -h, --help Show this message and exit. Commands: STAR STAR short help barcode extract barcode and umi short help cluster cluster short help count count short help cutadapt cutadapt short help featureCounts featureCounts short help run run short help sample sample short help
- sample
  设置报告中的样本信息.
  
  示例
  
  scope sample \ --transcriptome Homo_sapiens \ --sample samplename \ --outdir ./
  
  参数说明
  
  –outdir: 输出路径
  
  –version: 软件版本
  
  –description: 功能描述信息
  
  –sample: 样本名称
  
  –transcriptome: 转录组名称
- barcode
  基于read1序列信息 (barcode序列, linker序列, 质量值和polyT长度) 过滤, 提取并矫正barcode, 将矫正后的barcode和原始的UMI序列添加到read2的ID中.
  
  过滤规则:
  
  过滤polyT碱基数目<10的reads
  
  过滤barcode和UMI碱基质量值低于14的个数>2
  
  过滤两段接头中任何一段中错配碱基数>1
  
  过滤三段barcode中错配碱基数和>1
  
  barcode矫正规则:
  
  将未出现在whitelist中的barcode, 矫正为与whitelist中汉明距离为1的barcode.
  
  示例
  
  scope barcode \ --fq1 ./rawdata/R2005073_L1_1.fq.gz \ --fq2 ./rawdata/R2005073_L1_2.fq.gz \ --sample samplename \ --outdir ./ \ --bctype SCOPEv2
  
  参数说明
  
  –fq1: read1 fastq文件路径
  
  –fq2: read2 fastq文件路径
  
  –sample: 样本名称
  
  –outdir: 输出路径
  
  –bctype: 预置的接头类型
  
  –pattern: 自定义的接头结构, 字母C, L, U, T分别表示cell barcode、linker、UMI、T碱基, 数字表示碱基长度. C8L16C8L16C8L1U8T18即表示以下结构：
  
  CCCCCCCCLLLLLLLLLLLLLLLLCCCCCCCCLLLLLLLLLLLLLLLLCCCCCCCCLUUUUUUUUTTTTTTTTTTTTTTTTTT
  
  从第一个碱基开始，为C位置碱基构成cell barcode, 为U位置的碱基构成UMI, 第一段为L的碱基为linker1, 第二段为L的碱基为linker2, 末尾T为polyT.
  
  –whitelist 自定义的cell barcode白名单文件
  
  –linker: 自定义的linker白名单文件
  
  –lowQual: 定义为低质量碱基的质量值, 默认: 14
  
  –lowNum: 允许的低质量碱基的个数, 默认: 2
- cutadapt
  调用 cutadapt 对read2进行质控.
  
  trim接头序列
  
  trim两端低质量碱基
  
  示例
  
  scope cutadapt \ --fq ./samplename/01.barcode/samplename_2.fq.gz \ --sample samplename \ --outdir ./ \ --adapter p5=AGATCGGAAGAGCACACGTCTGAACTCCAGTCAC polyT=A{18} \ --overlap 5
  
  参数说明
  
  –fq: barcode处理后的read2 fastq文件
  
  –sample: 样本名称
  
  –outdir: 输出路径
  
  –adapter: 接头序列, 可多次使用, 默认: p5=AGATCGGAAGAGCACACGTCTGAACTCCAGTCAC polyT=A{18}
  
  –overlap: 认为检测到接头时重叠碱基数, 默认: 5
  
  –minimum-length: 允许的最短序列长度, 默认: 20
  
  –nextseq-trim: trim使用的质量值 (忽略G, 针对双色试剂, 如 NextSeq), 默认: 20
  
  –thread: 线程数, 默认: 2
- STAR
  调用 STAR 将read2序列定位到基因组上.
  
  示例
  
  scope STAR \ --fq ./samplename/02.cutadapt/samplename_2.fq.gz \ --sample samplename \ --outdir ./ \ --refFlat ./references/Homo_sapiens/Ensembl/GRCh38/Homo_sapiens.GRCh38.99.refFlat \ --genomeDir ./references/Homo_sapiens/Ensembl/GRCh38
  
  参数说明
  
  –fq: cutadapt处理后的read2 fastq文件
  
  –sample: 样本名称
  
  –readFilesCommand: STAR读取输入文件的命令, 默认: zcat
  
  –genomeDir: 参考基因组路径, 包含STAR所建索引
  
  –runThreadN: 线程数, 默认: 2
  
  –outdir: 输出路径
  
  –refFlat: refFlat文件路径
- featureCounts
  调用 featureCounts 将定位到基因组上的reads, 进一步定位到基因上.
  
  示例
  
  scope featureCounts \ --bam ./samplename/03.STAR/samplename_Aligned.sortedByCoord.out.bam \ --annot ./references/Homo_sapiens/Ensembl/GRCh38/Homo_sapiens.GRCh38.99.gtf \ --sample samplename \ --outdir ./
  
  参数说明
  
  –bam: STAR比对并排序后的bam文件
  
  –sample: 样本名称
  
  –annot: 基因组注释文件, gtf格式
  
  –nthreads: 线程数, 默认: 2
  
  –format: 输入文件的格式, 默认: BAM
  
  –outdir: 输出路径
- count
  对同一barcode内比对到同一基因的UMI序列进行校正, 之后进行UMI计数; 细胞数目评估(cell-calling); 输出单细胞基因表达矩阵.
  
  UMI矫正规则:
  
  对同一barcode中，比对到同一gene_id下的umi间进行校正
  
  若不存在mismatch为1的UMI，则取 原始UMI 为最终UMI;
  
  若存在mismatch为1的UMI，取 readcount数最大 的为最终UMI；
  
  若readcount数相同，则取 序列字符排序最大 的为最终UMI。
  
  细胞数目评估规则:
  
  以UMI count降序对barcode排序
  
  取第预设细胞数目*0.01为基准细胞
  
  取基准细胞的UMI count*0.1为阈值, 大于阈值则判定为细胞
  
  示例
  
  scope count \ --bam ./samplename/04.featureCounts/samplename_name_sorted.bam \ --cells 3000 \ --sample samplename \ --outdir ./
  
  参数说明
  
  –bam: featureCounts输出的bam文件
  
  –sample: 样本名称
  
  –cells: 预估细胞数, 默认: 3000
  
  –outdir: 输出路径
- cluster
  调用 scanpy 对表达矩阵进行分析, 得到细胞QC和初步的聚类图
  
  示例
  
  scope cluster \ --matrix ./samplename/05.count/samplename_matrix.mtx \ --barcodes ./samplename/05.count/samplename_barcodes.tsv --genes ./samplename/05.count/samplename_genes.tsv \ --outdir ./ --sample samplename
  
  参数说明
  
  –outdir: 输出路径
  
  –sample: 样本名称
  
  –matrix: 单细胞基因表达稀疏矩阵路径
  
  –barcodes: 表达稀疏矩阵路径
  
  –genes:
- run
  快速使用SCOPE-tools运行流程, 对数据进行分析.
  
  示例
  
  scope run \ --fq1 ./rawdata/R2005073_L1_1.fq.gz \ --fq2 ./rawdata/R2005073_L1_2.fq.gz \ --outdir ./ \ --bctype SCOPEv2 \ --annot ./references/Homo_sapiens/Ensembl/GRCh38/Homo_sapiens.GRCh38.99.gtf \ --refFlat ./references/Homo_sapiens/Ensembl/GRCh38/Homo_sapiens.GRCh38.99.refFlat \ --genomeDir ./references/Homo_sapiens/Ensembl/GRCh38 --sample samplename
  
  参数说明
  
  –fq1：read1 fastq文件路径
  
  –fq2：read2 fastq文件路径
  
  –outdir: 输出路径
  
  –bctype: 预置的接头类型
  
  –annot: 基因组注释文件, gtf格式
  
  –refFlat: refFlat文件路径
  
  –genomeDir: 参考基因组路径, 包含STAR所建索引
  
  –sample: 样本名称