fhModels {flowPloidy} | R Documentation

## Building Flow Histogram Models

### Description

Functions for assembling non-linear regression models for `FlowHist` objects.

### Usage

    addComponents(fh)

    dropComponents(fh, components)

    setLimits(fh)

    makeModel(fh, env = parent.frame())

### Arguments

`fh` | a `FlowHist` object
`components` | character, a vector of `ModelComponent` names.
`env` | an R environment. Don't change this, it's R magic to keep the appropriate environment in scope when building our model.

### Details

`addComponents` examines the model components in `fhComponents` and includes the ones that pass their `includeTest`.

`dropComponents` removes a component from the `FlowHist` model

`setLimits` collates the parameter limits for the model components included in a `FlowHist` object. (could be called automatically from `addComponents`, as it already is from `dropComponents`?)

`makeModel` creates a model out of all the included components.

### Value

The updated `FlowHist` object.

### Author(s)

Tyler Smith

[Package flowPloidy version 1.12.0 Index]