README.Rmd

---
title: "camprotR"
output: github_document
---

<!-- badges: start -->
[![R-CMD-check](https://github.com/CambridgeCentreForProteomics/camprotR/workflows/check-bioc/badge.svg)](https://github.com/CambridgeCentreForProteomics/camprotR/actions)
[![codecov](https://codecov.io/gh/CambridgeCentreForProteomics/camprotR/branch/master/graph/badge.svg)](https://codecov.io/gh/CambridgeCentreForProteomics/camprotR?branch=master)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
<!-- badges: end -->

The `camprotR` package is an internal package written and used by the 
[Cambridge Centre for Proteomics](https://proteomics.bio.cam.ac.uk) to 
facilitate our proteomic analyses. It is opinionated by design and most 
functions assume the data has been processed by Proteome Discoverer.

## Install

```{r, eval=FALSE}
remotes::install_github("CambridgeCentreForProteomics/camprotR", dependencies = TRUE)
```

## How to use

Vignettes which go through how to use different aspects of the package are 
available on the `camprotR` website [here](https://cambridgecentreforproteomics.github.io/camprotR/) (see Articles tab).