getMeanFunctions: Display available dose-response models

Description

Display information about available, built-in dose-response models.

Usage

1
  getMeanFunctions(noParm = NA, fname = NULL, flist = NULL, display =TRUE)

Arguments

noParm

numeric specifying the number of parameters of the models to be displayed. The default (NA) results in display of all models, regardless of number of parameters.

fname

character string or vector of character strings specifying the short name(s) of the models to be displayed (need to match exactly).

flist

list of built-in functions to be displayed.

display

logical indicating whether or not the requested models should be displayed on the R console.

Details

The arguments noParm and fname can be combined.

Value

An invisible list of functions or a list of strings with brief function descriptions is returned.

Author(s)

Christian Ritz

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Listing all functions
getMeanFunctions()

## Listing all functions with 4 parameters
getMeanFunctions(4)

## Listing all (log-)logistic functions
getMeanFunctions(fname = "L")

## Listing all three-parameter (log-)logistic or Weibull functions
getMeanFunctions(3, fname = c("LL", "W"))

## Listing all four-parameter (log-)logistic or Weibull functions
getMeanFunctions(4, fname = c("LL", "W"))

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.