rust-fmlrc

此仓库包含 FMLRC v2 的源代码，基于原始 FMLRC 使用的相同方法。在基准测试中，FMLRC v1 和 v2 之间的结果几乎相同，但测试表明 v2 相比 v1 使用了约 50% 的运行时间和 CPU 时间。

安装

所有安装选项都假设您已安装 Rust 以及 Rust 的 cargo 包管理器。

从 Cargo

cargo install fmlrc
fmlrc2 -h
fmlrc2-convert -h

从 GitHub

git clone https://github.com/HudsonAlpha/rust-fmlrc.git
cd rust-fmlrc
#testing optional, some tests will fail if ropebwt2 is not installed or cannot be found on PATH
cargo test --release
cargo build --release
./target/release/fmlrc2 -h
./target/release/fmlrc2-convert -h

使用方法

BWT 构建

msbwt2 构建方法

对于大多数用户，建议使用 msbwt2 包来 构建 BWT。这种方法通常更简单（只需一个命令）且更灵活（一次接受 FASTQ 和 FASTA 文件）。虽然它在内存和 CPU 使用方面通常与 ropebwt2 构建方法（见下文）具有竞争力，但它没有并行化并且通常运行速度较慢。

ropebwt2 构建方法

如果您熟悉更复杂的 shell 命令，则可以使用 ropebwt2 来构建 BWT。
对于 大多数 短读数据集，这种方法比 msbwt2-build 更快，但更复杂（需要多个管道命令）且灵活性较差（以下示例中固定为 FASTQ）。给定一个或多个带有额外标签的准确读取的 FASTQ 文件（reads.fq.gz，标签为 [reads2.fq.gz ...]），您可以使用此包中的以下命令在 comp_msbwt.npy 创建 BWT。请注意，此命令需要安装 ropebwt2 可执行文件

gunzip -c reads.fq.gz [reads2.fq.gz ...] | \
    awk 'NR % 4 == 2' | \
    sort | \
    tr NT TN | \
    ropebwt2 -LR | \
    tr NT TN | \
    fmlrc2-convert comp_msbwt.npy

注意：如果您 仅 使用 BWT 进行校正，则可以删除上述命令中的 sort。这将显著减少构建时间，但会丢失 BWT 的读取恢复属性。

校正

假设已构建准确的读取BWT（comp_msbwt.npy）并且存在未校正的读取数据（fasta/fastq，gzip可选，uncorrected.fq.gz），调用FMLRC v2相当简单

fmlrc2 [OPTIONS] <comp_msbwt.npy> <uncorrected.fq.gz> <corrected_reads.fa>

目前，仅支持输出读取数据的未压缩FASTA格式。

需要考虑的选项

1. -h - 查看完整选项列表并退出
2. -k，--K - 设置要使用的k-mer大小，默认为[21, 59]；所有值在校正之前按升序排序
3. -t，--threads - 要使用的校正线程数（默认：1）
4. -C，--cache_size - 预计算的序列长度（即C-mers）；这将通过减少查询的CPU时间O(C)来减少，但增加缓存内存使用量O(6^C)；默认的8使用约25MB；如果内存不是问题，考虑使用10，使用约1GB的缓存占用（或如果内存真的不是问题，更大）