editmrbin: A function for editing mrbin objects.

In mrbin: Metabolomics Data Analysis Functions

A function for editing mrbin objects.

Description

This function edits an mrbin object and returns it. This is the only documented way to edit mrbin objects, all other ways of editing such object might cause warning message

Usage

editmrbin(
  mrbinObject,
  functionName = "mrbin::editmrbin",
  versionNumber = as.character(utils::packageVersion("mrbin")),
  bins = NULL,
  parameters = NULL,
  metadata = NULL,
  transformations = NULL,
  comment = "",
  verbose = TRUE
)

Arguments

mrbinObject	An mrbin object
functionName	Name of the package and function calling this command
versionNumber	Version number of the package calling this command
bins	A matrix containing values to be written to the mrbin object
parameters	A list containing values to be written to the mrbin object parameters, names must be names of the mrbin object, e.g. dimension
metadata	A list containing values to be written to the mrbin object parameters, names must be names of the mrbin object
transformations	An optional character vector describing any used data transformations or scaling such as reference scaling, PQN, log, atnv, etc.
comment	An optional character vector describing the change
verbose	Should a summary be displayed?

Value

An (invisible) mrbin object

Examples

mrbinObject<-createmrbin()
mrbinObject<-editmrbin(mrbinObject)

mrbin documentation built on June 22, 2024, 9:39 a.m.