Data

Tools

Indexes

Applications

Experiments

Open Source Science

tofdaqr

R Interface to the TOFWERK TofDaq API

https://github.com/pasturm/tofdaqr

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

R Interface to the TOFWERK TofDaq API

Basic Info
  • Host: GitHub
  • Owner: pasturm
  • Language: C++
  • Default Branch: master
  • Homepage:
  • Size: 40 MB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Created over 9 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Citation

README.md

TofDaqR

Project Status: Active – The project has reached a stable, usable state and is being actively developed. <!-- badges: end -->

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: r 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: r 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

r 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.

Owner

  • Name: Patrick Sturm
  • Login: pasturm
  • Kind: user
  • Location: Thun, Switzerland

Citation (CITATION.cff) 

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v1.0.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "TofDaqR" in publications use:'
type: software
license: GPL-3.0-only
title: 'TofDaqR: R Interface to the TOFWERK TofDaq API'
version: 0.3.10.9010
abstract: The TofDaqR package provides an 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.
authors:
- family-names: Sturm
  given-names: Patrick
  email: sturm@tofwerk.com
repository-code: https://github.com/pasturm/TofDaqR
url: https://github.com/pasturm/TofDaqR
contact:
- family-names: Sturm
  given-names: Patrick
  email: sturm@tofwerk.com
references:
- type: software
  title: Rcpp
  abstract: 'Rcpp: Seamless R and C++ Integration'
  notes: Imports
  url: http://www.rcpp.org
  repository: https://CRAN.R-project.org/package=Rcpp
  authors:
  - family-names: Eddelbuettel
    given-names: Dirk
  - family-names: Francois
    given-names: Romain
  - family-names: Allaire
    given-names: JJ
  - family-names: Ushey
    given-names: Kevin
  - family-names: Kou
    given-names: Qiang
  - family-names: Russell
    given-names: Nathan
  - family-names: Ucar
    given-names: Inaki
  - family-names: Bates
    given-names: Douglas
  - family-names: Chambers
    given-names: John
  year: '2024'
  version: '>= 0.12.7'
- type: software
  title: Rcpp
  abstract: 'Rcpp: Seamless R and C++ Integration'
  notes: Imports
  url: http://www.rcpp.org
  repository: https://CRAN.R-project.org/package=Rcpp
  authors:
  - family-names: Eddelbuettel
    given-names: Dirk
  - family-names: Francois
    given-names: Romain
  - family-names: Allaire
    given-names: JJ
  - family-names: Ushey
    given-names: Kevin
  - family-names: Kou
    given-names: Qiang
  - family-names: Russell
    given-names: Nathan
  - family-names: Ucar
    given-names: Inaki
  - family-names: Bates
    given-names: Douglas
  - family-names: Chambers
    given-names: John
  year: '2024'

GitHub Events

Total
Last Year

Dependencies

DESCRIPTION cran
  • Rcpp >= 0.12.7 imports