sequana项目的fastqc管道。
sequana-fastqc的Python项目详细描述
这是来自Sequana项目的fastqc管道
Overview: | Runs fastqc and multiqc on a set of Sequencing data to produce control quality reports |
---|---|
Input: | A set of FastQ files (paired or single-end) compressed or not |
Output: | an HTML file summary.html (individual fastqc reports, mutli-samples report) |
Status: | production |
Wiki: | https://github.com/sequana/sequana_fastqc/wiki |
Documentation: | This README file, the Wiki from the github repository (link above) and https://sequana.readthedocs.io |
Citation: | Cokelaer et al, (2017), ‘Sequana’: a Set of Snakemake NGS pipelines, Journal of Open Source Software, 2(16), 352, JOSS DOI https://doi:10.21105/joss.00352 |
安装
必须先安装Seguana(使用–upgrade可安装最新版本):
pip install sequana --upgrade
然后,只需安装以下软件包:
^{pr2}$使用
此命令将扫描以结尾的所有文件。速成gz在当地发现的 目录,创建一个名为fastqc/的目录,其中有一个snakemake管道 自动启动。根据文件的数量和大小 过程可能很长:
sequana_fastqc --run
了解更多关于选项的信息(例如,添加一个不同的模式来限制 执行输入文件的子集,更改输出/工作目录, 等等):
sequana_pipelines_fastqc --help sequana_pipelines_fastqc --input-directory DATAPATH
这将创建一个目录fastq。您只需执行管道:
cd fastqc sh fastqc.sh # for a local run
这是一条蛇形管道。如果你熟悉蛇咬,你可以取回快速质控规则以及配置.yaml文件,然后使用特定参数自行执行管道:
snakemake -s fastqc.rules --cores 4 --stats stats.txt
或者使用sequanix接口。在
请参阅Wiki了解更多示例和特性。在
教程
您可以从sequona_fastqc(https://github.com/sequana/sequana_fastqc)或键入以下内容来检索测试数据:
wget https://raw.githubusercontent.com/sequana/sequana_fastqc/master/sequana_pipelines/fastqc/data/data_R1_001.fastq.gz wget https://raw.githubusercontent.com/sequana/sequana_fastqc/master/sequana_pipelines/fastqc/data/data_R2_001.fastq.gz
然后,准备管道:
sequana_fastqc --input-directory . cd fastqc sh fastq.sh # once done, remove temporary files (snakemake and others) make clean
只需打开名为摘要.html. 还提供多重质量控制报告。 您将获得如下所示的预期图像:
请参阅Wiki了解更多示例和特性。在
要求
此管道需要以下可执行文件:
- 快速质控
- falco(可选)
- seguana(Python:pip install seguana)
对于Linux用户,我们通过damona提供了一个singularity映像:
pip install damona damona install fastqc # and add the ~/.config/damona/bin path to your binary PATH
细节
此管道在输入的fastq文件上并行运行fastqc(成对或不成对) 然后执行multiqc。同时还制作了一份简短的Seguana摘要报告。在
规则和配置详细信息
这是latest documented configuration file 与管道一起使用。管道中使用的每个规则在配置文件中可能有一个部分。在
变更日志
^{tb2}$贡献和行为准则
为了对这个项目有所贡献,请看一下 Contributing Guidelines先。请注意,此项目发布时带有 Code of Conduct。为本项目捐款即表示您同意遵守其条款。在
- 项目
标签: