nmrfit_1d: Fit an NMRScaffold1d object to a set of data

Description Usage Arguments Value

Description

To do.

Usage

1
2
3
4
nmrfit_1d(object, nmrdata = NULL, normalized = TRUE, bounds = TRUE,
  coupling.leeway = 0, area.leeway = 0, satellite.leeway = 0,
  ordered.peaks = character(), include.convolution = TRUE,
  components = "r/i", opts = NULL)

Arguments

object

An NMRScaffold1D object.

nmrdata

An NMRData1D object. Optional if the NMRScaffold1D object has the nmrdata slot set.

normalized

TRUE to use a normalized fit. If the parameters or bounds are not already normalized, they will be normalized to the data. If FALSE, previously normalized data will be rescaled before fit.

bounds

TRUE to use bounds (setting conservative bounds if none exist), FALSE to ignore any attached bounds.

coupling.leeway

Fraction of possible error in specified coupling constants. Switching to a non-zero value results in the use of inequality constraints.

area.leeway

Fraction of possible error in specified area ratios of coupled peaks. Switching to a non-zero value results in the use of inequality constraints.

satellite.leeway

Fraction of possible error in the symmetry of satellite positions as a function of the distance between a satellite and the main peak. Switching to a non-zero value results in the use of inequality constraints.

ordered.peaks

A vector of peak ids (names) whose order relative to each other is not allowed to change. This option can be useful for preventing an arbitrary collection of singlets used to fit a more complex peak from drifting past or on top of each other, leading to ill-defined optimization.

include.convolution

TRUE to include convolution vector of nmrdata into fit (if present), FALSE to ignore it.

components

String specifying the complex data componets to use for the fit (one of either "r/i", "r", or "i").

opts

NLOPT option list used to overried default values.

Value

An NMRFit1D object.


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