4个版本

0.2.5 2021年9月18日
0.2.4 2021年9月18日
0.2.3 2021年8月28日
0.1.0 2021年8月28日

#1683 in 解析器实现

MIT许可证

31KB
800

MSn Kit

一个用于处理质谱数据的库(Rust)和CLI(mm)。

CLI快速入门

下载可执行文件后,使用 --help 查看命令和选项。

$ mm --help
msn-kit 0.2.3
Trent Hauck <[email protected]>
CLI for dealing with MGF files.

USAGE:
    mm [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -o <output-format>        The output file to write to [default: mgf]

SUBCOMMANDS:
    head               Similar to head(1) in that it can output the top n records from an MGF
                       file
    help               Prints this message or the help of the given subcommand(s)
    metadata-filter    Select spectra based on the key value pairs in the metadata
    stats              Compute stats for inputs

根据安装的版本与最后一次更新README的差异,您的界面可能不同 😄。您可能还希望将 mm 放置在您的 PATH 上的某个位置。

安装

版本发布在GitHub的发布页面上: https://github.com/tshauck/msn-kit/releases/latest

从那里,下载适用于适当平台的版本。

目前有

  • x86 Darwin
  • x86 Linux
  • x86 Windows
  • ARM Linux

用法

关于CLI组织的一些建议。

  • CLI以 mm 的单个入口点组织,然后是子命令,例如 mm statsmm headmm metadata-filter 等。它们都接受 -h 标志以获取帮助。
  • 许多命令可以接受一个 -o 全局参数(即直接传递给 mm),以指定输出格式。 mgf 是一个选项,它会输出预期的内容。 json 也是一个选项,它将输出json记录,每行一个。

状态徽章

流程 状态
Github发布构建 GitHub Workflow Status
Github测试 GitHub Workflow Status

依赖

~2.5–3.5MB
~66K SLoC