README.md

In pasturm/TofDaqR: R Interface to the TOFWERK TofDaq API

TofDaqR

R Interface to the TOFWERK TofDaq API

The TofDaqR package provides a R interface to the TOFWERK TofDaq API, which consists of libraries for communication with the TofDAQ recorder application, data file access and general (time-of-flight) mass spectrometry related utility functions.

Features:

• Acquisition setup and control
• Real-time data access
• Adding (structured) custom data to the data file alongside the TOF data
• Control of the TOF Power Supply
• Quick access to TOFWERK HDF5 data files without the need to study the file format details
• Add additional data to existing data files (e.g. post-processing results)
• Peak fitting functions
• Mass calibration
• Chemistry functions (molecular mass and isotope pattern calculation)
• Single ion analysis functions

Installation

On Windows:

install.packages("https://github.com/pasturm/TofDaqR/releases/download/v0.3.11/TofDaqR_0.3.11.zip", repos = NULL)

Alternatively, the latest development version can be installed from source on Windows, macOS (with Intel-based processors) and Linux:

if (!require("remotes")) { install.packages("remotes") }
remotes::install_github("pasturm/TofDaqR", clean = TRUE)

Installing from source requires Rtools on Windows, Xcode Command Line Tools (xcode-select --install) on macOS and sudo apt-get install r-base-dev (or similar) on Linux.

Please note: the TofDaq API libraries are not (yet) available for ARM-based processors.

Documentation

help(package = "TofDaqR")  # Index of help pages
help("API-documentation", package = "TofDaqR")  # Links to the TOFWERK TofDaq API documentation

Release notes

See the NEWS file for latest release notes.

pasturm/TofDaqR documentation built on March 29, 2024, 12:10 a.m.