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

Description Usage Arguments Value

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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 Nov. 23, 2018, 12:25 a.m.