README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```


# FTMS.peakCharacterization


The goal of the FTMS.peakCharacterization package is to facilitate scan-centric peak characterization of profile level, multi-scan, direct-injection Fourier-transform mass spectrometry data.

You can read more about the merits of this scan-centric method in:

RM Flight, JM Mitchell & HNB Moseley, "Scan-Centric, Frequency-Based Method for Characterizing Peaks from Direct Injection Fourier transform Mass Spectrometry Experiments", bioRxiv, doi: https://doi.org/10.1101/2022.04.14.488423

## License

This package is licensed with a [BSD-like license](LICENSE.md) with a 4th clause: No commercial use.

Academics who want to use it at their institution, please try it.

If you are at a business / for-profit and want to use it, please contact the authors about licensing.
Please contact us even if you aren't sure what would be required for licensing, we do want people to use it.

## Installation

**Warning**: The authors of this package have not gone through and updated the dependencies for this package for a while.
Therefore, when installing right now, you will likely get messages about missing dependencies.
Please feel free to [file an issue](https://github.com/MoseleyBioinformaticsLab/FTMS.peakCharacterization/issues) if you need help getting it up and running.
This situation should be remedied shortly.

You can install the development version of FTMS.peakCharacterization from [GitHub](https://github.com/) with:

``` r
# install.packages("remotes")
remotes::install_github("MoseleyBioinformaticsLab/FTMS.peakCharacterization")
```

## Example

We are lacking basic examples at the moment.
We are hoping to get some basic example and more documentation of the functionality in here shortly.