MSn Kit

A library (in Rust) and CLI (mm) for working with Mass Spectrometry data.

Quick Start for CLI

After downloading the executable, use --help to see the commands and options.

```console $ mm --help msn-kit 1.0 Trent Hauck trent@trenthauck.com CLI for dealing with MGF files.

USAGE: mm [OPTIONS]

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

OPTIONS: -o The output file to write to [default: mgf] [possible values: json, 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 spetra based on the key value pairs in the metadata ```

Yours may look different depending on the version that was installed vs the last time this README was updated 😄. You'll also likely want to place mm is a location that is on your PATH.

Installation

Releases are made to GitHub's release page: https://github.com/tshauck/msn-kit/releases/latest.

From there, download the version you'd like to use for the appropriate platform.

Currently there are builds for:

Usage

A few things to note about the CLI's organization.

Status Badges

| Process | Status | | ----------- | ----------- | | Github Release Build | GitHub Workflow Status | | Github Tests | GitHub Workflow Status |