set_peak_units: Switch NMRScaffold1D or NMRScaffold2D parameter units between...

In ssokolen/rnmrfit: Robust NMR Lineshape Fitting in the Frequency Domain

Description

Although it's more practical to refer to peak width in terms of Hz, optimization requires that the width parameters be in ppm. This conversion should generally be handled automatically, but it can be overriden manually if desired.

Usage

set_peak_units(object, nmrdata = NULL, peak.units = "hz",
  include.bounds = TRUE, ...)

## S4 method for signature 'NMRScaffold'
set_peak_units(object, nmrdata = NULL,
  peak.units = "hz", include.bounds = TRUE)

## S4 method for signature 'NMRScaffold1D'
set_peak_units(object, nmrdata = NULL,
  peak.units = "hz", include.bounds = TRUE)

## S4 method for signature 'NMRFit1D'
set_peak_units(object, nmrdata = NULL,
  peak.units = "hz", include.bounds = FALSE)

Arguments

object	An NMRScaffold1D or NMRScaffold2D object.
nmrdata	An optional NMRData object needed for conversion parameters.
peak.units	One of either 'hz' or 'ppm'.
include.bounds	TRUE to perform the same operation on bounds.
...	Additional arguments passed to inheriting methods.

Value

An updated NMRScaffold1D or NMRScaffold2D object.

ssokolen/rnmrfit documentation built on May 23, 2019, 1:48 p.m.