# maldi-end-group-analysis

> ## Prerequisites

Latest version **0.4.1** (published 2023-08-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install maldi-end-group-analysis
pnpm add maldi-end-group-analysis
yarn add maldi-end-group-analysis
bun add maldi-end-group-analysis
```

Provides the command `maldi`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2023-08-15 |
| First published | 2022-04-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 28 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | lewis785 |

## Links

- npm: https://www.npmjs.com/package/maldi-end-group-analysis
- Repository: https://github.com/lewis785/maldi-end-group-analysis
- Homepage: https://github.com/lewis785/maldi-end-group-analysis#readme
- Issues: https://github.com/lewis785/maldi-end-group-analysis/issues
- npm.io page: https://npm.io/package/maldi-end-group-analysis

## Dependencies (7)

- [jest](https://npm.io/package/jest.md) ^27.4.7
- [yargs](https://npm.io/package/yargs.md) ^17.3.1
- [ts-jest](https://npm.io/package/ts-jest.md) ^27.1.2
- [@types/jest](https://npm.io/package/@types/jest.md) ^27.4.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.0.0
- [eslint-config-airbnb-typescript](https://npm.io/package/eslint-config-airbnb-typescript.md) ^16.1.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.0.0

## Recent versions

- 0.4.1 (latest) — 2023-08-15
- 0.4.0 — 2023-08-15
- 0.3.0 — 2023-08-15
- 0.2.1 — 2022-06-13
- 0.2.0 — 2022-04-24
- 0.1.0 — 2022-04-22

## README

[![Tests](https://github.com/lewis785/maldi-end-group-analysis/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/lewis785/maldi-end-group-analysis/actions/workflows/test.yml)

# maldi-end-group-analysis

## Prerequisites

### Volta

This repository uses [Volta](https://volta.sh) to manage its `Node` and `Yarn` versions.

To install Volta run this command

```shell script
curl https://get.volta.sh | bash
```

---

## Command Line Interface (CLI)

### Setup

Install Globally

```shell script
npm install maldi-end-group-analysis -g
```

### Usage

Show all commands:

```shell script
maldi --help

Usage: maldi <command> [options]

Commands:
  maldi analyse [file] [options]  Run maldi end group analysis
  maldi example-file [format]     Generate example import file

Options:
  --version  Show version number                             [boolean]

Examples:
  maldi example-file csv                          Generate an example csv file
  maldi analyse input.csv -t 10 -o test-result    Run analysis on file

```

Show options for `analyse` command:

```shell script
maldi analyse --help

Usage: maldi [options]

Options:
      --version    Show version number                      [boolean]
  -f, --file       Path to file being analysed              [string] [required]
  -t, --threshold  Maximum allowed difference from peak     [number] [required] [default: 0]
  -o, --output     Output file name                         [string] [default: "results"]
  --format     Format of file that should be outputted      [string] [choices: "csv"] [default: "csv"]
```

To analyse a file called `input.csv` with a threshold of `0`, then output the results to a file called `results.csv`:

```shell script
maldi analyse input.csv
```

To analyse a file called `input.csv` with a threshold of `100`, then output the results to a file called `result_file.csv`:

```shell script
maldi analyse input.csv -o result_file -t 100
```

## Development

### Setup CLI

```shell script
yarn install
yarn build
yarn setup-cli
```

---
_Source: https://npm.io/package/maldi-end-group-analysis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._