12 个版本

0.9.0 2024年3月8日
0.8.2 2023年6月29日
0.8.1 2023年1月13日
0.8.0 2022年10月11日
0.4.1 2021年7月22日

#20 in 生物学

自定义许可

335KB
6K SLoC

logo

alevin-fry Rust Anaconda-Server 徽章 Anaconda-Server 徽章 GitHub 标签 (最新 SemVer)

alevin-fry 是一套用于快速、准确且节省内存的单细胞和单核测序数据处理的工具。它使用由 piscemsalmon alevin 生成的 RAD 文件,并执行如生成许可列表和估计每个细胞中每个基因的独特的分子数等常见操作。在 alevin-fry 中,重点是安全性、准确性以及效率(包括时间和内存使用)。

您可以在这里阅读描述 alevin fry 的论文,“Alevin-fry unlocks rapid, accurate, and memory-frugal quantification of single-cell RNA-seq data”,以及在 bioRxiv 上的预印本

注意:我们建议使用 piscem 作为后端映射器,而不是 salmon,因为它更加节省资源、更快,并且是当前和未来开发的主要焦点。

开始使用 alevin-fry 和专门的文档

虽然这个 README 包含了一些入门信息和一些提示,但 alevin-fry 有自己的专用文档网站,托管在 ReadTheDocs 上。

更多信息

  • 使用 simpleaf 包装器进行快速入门指南

  • 与 alevin 的关系:alevin-fry 是 alevin 的继任者。它包含了 alevin 的核心功能,同时提供了重要的新功能,并显著提高了性能。我们预计新的方法开发和功能添加将主要在 alevin-fry 代码库中进行。因此,我们鼓励 alevin 用户在可行时迁移到 alevin-fry。但话虽如此,alevin 仍然处于活跃维护和支持状态,所以如果你在使用它并且还没有准备好迁移,你仍然可以在 salmon 仓库 中提问和提交问题。

常见问题解答

你对使用稀疏索引还是密集索引这样的处理细节好奇吗?或者你有其他不是故障报告或功能请求的问题,也不是由文档或教程直接回答的问题?那么请随时在 Q&A 中提问。

姐妹仓库

  • alevin-fry 处理的减少对齐数据 (RAD) 文件是由 piscemsalmon 生成的。这两个的最新版本都可以在 GitHub 和 bioconda 上找到。

  • simpleaf 仓库包含一个用于处理 alevin-fry 数据的专用包装器/工作流程运行器,极大地简化了扩展参考的创建以及后续样本的量化。如果你发现 simpleaf 缺少了你想要的功能,请考虑在 simpleaf 仓库 中提交功能请求。

  • pyroe 仓库提供工具,帮助轻松地从参考基因组和 GTF 文件构建增强(剪接 + 内含子剪接 + 未剪接)转录组。

  • fishpond 包——由 @mikelove 及其实验室维护——包含将 alevin-fry 输出(尤其是 USA 模式输出)读入 R 生态系统的推荐相关函数,形式为一个 singleCellExperiment 对象。

  • alevinqc 包——由 @csoneson 维护——提供在 alevin-fry 之后进行质量控制和评估的工具和函数。

从 bioconda 安装

Alevin-fry 可用于 x86 Linux 和 OSX 平台 通过 bioconda。在 Apple Silicon 上,你可以通过源代码(见下文)轻松构建,或者运行在 rosetta 2 模拟层下的 alevin-fry

在您的通道列表中将 bioconda 放在合适的位置后,您应该可以通过以下方式安装:

$ conda install -c bioconda alevin-fry

从 crates.io 安装

Alevin-fry 还可以从 crates.io 使用 cargo 安装。可以使用以下命令完成此操作:

$ cargo install alevin-fry

从源代码构建

如果您想使用仅在最新开发分支(或为不同架构构建)中可用的功能或修复,那么您必须从源代码构建。幸运的是,cargo使这变得很容易;请参见下文。

Alevin-fry是用最新的(主版和次版)稳定版本的Rust构建和测试的。虽然它可能与稍微旧一点的Rust版本编译良好,但这不是保证,也不是支持的重点。与C++不同,Rust具有频繁且稳定的发布周期,旨在从用户空间安装和更新,并且可以通过rustup轻松保持更新。多亏了cargo,构建应该和下面这样简单

$ cargo build --release

下面的命令将假设可执行文件在您的路径中。暂时,这可以通过(在bash-like shells中)使用以下方法完成

$ export PATH=`pwd`/target/release/:$PATH

Alevin-fry的引用

如果您在您的作品中使用了alevin-fry,请引用

He, D., Zakeri, M., Sarkar, H., Soneson, C., Srivastava, A.,和Patro, R. Alevin-fry解锁了单细胞RNA-seq数据的快速、准确和内存节俭的量化。Nat Methods 19, 316–322 (2022)。 https://doi.org/10.1038/s41592-022-01408-3

BibTeX

@Article{He2022,
author={He, Dongze and Zakeri, Mohsen and Sarkar, Hirak and Soneson, Charlotte and Srivastava, Avi and Patro, Rob},
title={Alevin-fry unlocks rapid, accurate and memory-frugal quantification of single-cell RNA-seq data},
journal={Nature Methods},
year={2022},
month={Mar},
day={01},
volume={19},
number={3},
pages={316-322},
issn={1548-7105},
doi={10.1038/s41592-022-01408-3},
url={https://doi.org/10.1038/s41592-022-01408-3}
}

依赖项

~27–39MB
~625K SLoC