https://github.com/jasenfinch/grover

Web API Framework for Mass Spectrometry Data Transfer
https://github.com/jasenfinch/grover

conversion mass-spectrometry metabolomics-data metadata plumber-api r-package transfer web-api

Last synced: 4 days ago
JSON representation

Web API Framework for Mass Spectrometry Data Transfer

• Host: GitHub
• URL: https://github.com/jasenfinch/grover
• Owner: jasenfinch
• License: gpl-3.0
• Created: 2018-02-01T13:23:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-07-25T13:34:07.000Z (over 1 year ago)
• Last Synced: 2023-07-25T14:55:32.360Z (over 1 year ago)
• Topics: conversion, mass-spectrometry, metabolomics-data, metadata, plumber-api, r-package, transfer, web-api
• Language: R
• Homepage: https://jasenfinch.github.io/grover/
• Size: 6.43 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        

# grover

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![R-CMD-check](https://github.com/jasenfinch/grover/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jasenfinch/grover/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/jasenfinch/grover/branch/master/graph/badge.svg)](https://codecov.io/gh/jasenfinch/grover?branch=master)

[![license](https://img.shields.io/badge/license-GNU%20GPL%20v3.0-blue.svg)](https://github.com/jasenfinch/grover/blob/master/DESCRIPTION)

[![GitHub release](https://img.shields.io/github/release/jasenfinch/grover.svg)](https://GitHub.com/jasenfinch/grover/releases/)

### Overview

The `grover` package provides a web-based API framework for remote access to a mass spectrometry `.raw` data repository, implemented using the [`plumber`](https://www.rplumber.io/) R package.

API functionality includes:

* **File information** retrieval including file size and creation dates.

* File **transfer**.

* Raw mass spectrometry data file **conversion** to `.mzML` format.

* Retrieval of **sample information** from `.raw` file headers.

The package functionality is platform independent with file conversion and sample information retrieval functionality available through use of the [`msconverteR`](https://github.com/wilsontom/msconverteR) and [`rawrr`](https://github.com/fgcz/rawrr) R packages.

### Installation

The `grover` package can be installed from GitHub using the following:

```

remotes::install_github('jasenfinch/grover')

```

### Learn more

The package documentation can be browsed online at . 

If you believe you've found a bug in `grover`, please file a bug (and, if

possible, a [reproducible example](https://reprex.tidyverse.org)) at

.