Lib.rs

关于

HyperEx（发音为“Hyper Ex”，即高变区提取器）是一个基于一组引物提取16S核糖体RNA（rRNA）高变区的工具。默认情况下，如果没有指定选项，HyperEx会假定是16S rRNA序列，从提供的序列中提取所有高变区。为此，它有一组内置的引物序列，这是通用的16S引物序列。然而，用户可以通过指定 --region 选项或使用 --forward-primer 和 --reverse-primer 提供引物序列来选择想要提取的区域。 --region 选项仅接受区域名称，如“v1v2”或“v4v5”，而 --forward-primer 和 --reverse-primer 仅接受可能包含IUPAC不确定性的序列。
对于需要多个区域，可以使用多次 --region、--forward-primer、reverse-primer 选项来指定所需的区域。这些选项仅接受一个参数，但可以重复多次（见下面的示例）。

为了更方便，用户还可以提供一个包含引物序列的文件，使用 --region 选项提取所需区域。引物序列文件应该是一个没有标题的逗号分隔值文件，如下所示

FORWARD_PRIMER_1,REVERSE_PRIMER_1
FORWARD_PRIMER_2,REVERSE_PRIMER_2
...

此外，可以使用 --mismatch 选项允许引物序列中有一定数量的不匹配。

输出是一个包含提取区域的fasta文件和一个指示提取区域位置的GFF3文件。

安装

使用预构建的二进制文件

请参阅发布页面以获取主要操作系统的预构建二进制文件

从crates.io

如果您已经安装了有效的Rust，可以轻松地做

cargo install hyperex

这就完成了！

从源码

git clone https://github.com/Ebedthan/hyperex.git
cd hyperex

cargo build --release
cargo test

# To install hyperex in current directory
cargo install --path .

您就可以开始了！

如何运行HyperEx？

默认情况下，不带选项

# reading data from a specified file
hyperex file.fa

# reading data from standard input
cat file.fa | hyperex

使用内置的16S引物名称

# reading data from a specified file
hyperex -f 27F -r 337R file.fa.gz

# reading data from standard input
zcat file.fa.gz | hyperex -f 27F -r 337R

使用内置的16S区域名称

# reading data from a specified file
hyperex --region v3v4 file.fa.xz

# reading data from standard input
xzcat file.fa.xz | hyperex --region v3v4

使用自定义引物序列

# reading data from a specified file
hyperex -p prefix --forward-primer ATCG --reverse-primer TYAATG file.fa.bz2

# reading data from standard input
bzcat file.fa.bz2 | hyperex -p prefix --forward-primer ATCG --reverse-primer TYAATG

使用自定义引物列表：primers.txt

hyperex --region primers.txt file.fa

使用多个引物

hyperex --region v1v2 --region v3v4 file.fa

hyperex -f ATC -f YGA -r GGCC -r TTRC file.fa

用法

命令行参数

hyperex [FLAGS] [OPTIONS] <FILE>

标志

    --force      Force output overwritting
-q, --quiet      Decreases program verbosity
-h, --help       Prints help information
-V, --version    Prints version information

选项

-f, --forward-primer <PRIMER>...    Specifies forward primer sequence. Can be a sequence with degenerate bases
-r, --reverse-primer <PRIMER>...    Specifies reverse primer sequence. Can be a sequence with degenerate bases
    --region <REGION>...            Specifies a hypervariable region to extract
-m, --mismatch <N>                  Specifies number of allowed mismatch [default: 0]
-p, --prefix <PATH>                 Specifies the prefix for the output files [default: hyperex_out]

参数

<FILE>    Input fasta file. Can be gzip'd, xz'd or bzip'd

需求

必需

• Rust 稳定频道

可选

• libgz 以支持gz文件
• liblzma 以支持xz文件
• libbzip2 以支持bzip2文件

注意

Hyperex在帮助中使用了彩色输出，但仍然尊重NO_COLORS环境变量。

问题

将问题或请求提交到问题跟踪器。