Redundans 使用教程

Redundans 使用教程

redundans Redundans is a pipeline that assists an assembly of heterozygous/polymorphic genomes. 项目地址: https://gitcode.com/gh_mirrors/re/redundans

1. 项目目录结构及介绍

Redundans 是一个用于组装异源双倍体/多态性基因组的管道工具。项目目录结构如下：

redundans/
├── .gitmodules
├── bin/
│   └── .compile.sh
├── docs/
├── Dockerfile
├── INSTALL.sh
├── LICENSE
├── README.md
├── redundans.py
├── test/
└── workflows/

• .gitmodules：用于管理子模块的配置文件。
• bin/：包含编译脚本 .compile.sh。
• docs/：存放项目文档。
• Dockerfile：用于构建 Redundans 的 Docker 镜像。
• INSTALL.sh：项目安装脚本。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• redundans.py：项目的主要 Python 脚本，用于执行组装流程。
• test/：包含测试数据。
• workflows/：包含项目的工作流定义。

2. 项目的启动文件介绍

项目的启动文件是 redundans.py，它是项目的主要 Python 脚本。通过这个脚本，用户可以运行 Redundans 管道来组装基因组。以下是一些基本的命令行选项：

-h, --help            显示帮助信息并退出
-v, --verbose         开启详细模式
--version             显示程序的版本号并退出
-i FASTQ, --fastq FASTQ
FASTQ PE / MP 文件
-f FASTA, --fasta FASTA
FASTA 文件，包含组装后的片段/支架
-o OUTDIR, --outdir OUTDIR
输出目录 [redundans]
-t THREADS, --threads THREADS
运行的线程数 [4]
--resume              从上次运行状态恢复
--log LOG             输出日志到 [stderr]
--nocleaning          不进行清理操作

3. 项目的配置文件介绍

Redundans 的配置主要是通过命令行参数来完成的。目前没有独立的配置文件，但是用户可以在命令行中指定不同的参数来调整组装流程的行为。

以下是一些关键的配置选项：

• -i 或 --fastq：指定输入的 FastQ 文件，包含成对的末端或配对读取。
• -f 或 --fasta：指定包含组装后的片段或支架的 FastA 文件。
• -o 或 --outdir：指定输出目录。
• -t 或 --threads：指定使用的线程数，以提高处理速度。

在运行 redundans.py 时，可以通过命令行参数来调整这些设置，以满足不同的组装需求。如果需要重复使用相同的配置，可以考虑将命令行参数保存到一个脚本文件中，然后执行该脚本。

redundans Redundans is a pipeline that assists an assembly of heterozygous/polymorphic genomes. 项目地址: https://gitcode.com/gh_mirrors/re/redundans