options: Infusion options settings

Description Usage Arguments Details Value References Examples

Description

Allow the user to set and examine a variety of options which affect operations of the Infusion package. However, typically these should not be modified, and if they are, not more than once in a data analysis.

Usage

1
2
3

Arguments

x

a character string holding an option name.

...

A named value or a list of named values. The following values, with their defaults, are used in Infusion:

projTrainingSize = 200:

default value of trainingsize argument of project.character.

projKnotNbr = 300:

default value of knotnbr argument of project.character.

logLname = "logL":

default value of logLname argument of infer_logLs. The name given to the inferred log likelihoods in all analyses.

LRthreshold= - qchisq(0.999,df=1)/2:

A value used internally by sample_volume to sample points in the upper region of the likelihood surface, as defined by the given likelihood ratio threshold.

precision = 0.1:

default value of precision argument of refine. Targets RMSE of log L and log LR estimates.

nRealizations=1000:

default value of nRealizations argument of add_simulation. Number of realizations for each empirical distribution.

mixmodGaussianModel="Gaussian_pk_Lk_Dk_A_Dk":

default models used in clustering by Rmixmod. Run Rmixmod::mixmodGaussianModel() for a list of possible models, and see the statistical documentation (Mixmod Team 2016) for explanations about them.

nbCluster = quote(seq(ceiling(nrow(data)^0.3))):

default value of nbCluster used in clustering by Rmixmod

example_maxtime=2.5:

Used in the documentation to control whether the longer examples should be run. The approximate running time of given examples (or some very rough approximation for it) on one author's laptop is compared to this value.

and possibly other undocumented values for development purposes.

Details

Invoking Infusion.options() with no arguments returns a list with the current values of the options. Invoking Infusion.getOption(<option name>) returns the value of the option rather than a list.

The default nbCluster value is the upper value of the range recommended in the mixmod statistical documentation (Mixmod Team, 2016). If clustering by the given number(s) of clusters fails, decreasing values are tryied until success.

Value

For Infusion.getOption, the current value set for option x, or NULL if the option is unset.

For Infusion.options(), a list of all set options sorted by category. For Infusion.options(name), a list of length one containing the set value, or NULL if it is unset. For uses setting one or more options, a list with the previous values of the options changed (returned invisibly).

References

Mixmod Team (2016). Mixmod Statistical Documentation. Université de Franche-Comté, Besançon, France. Version: February 10, 2016 retrieved from http://www.mixmod.org.

Examples

1
2
3
4
5
6
  Infusion.options()
  Infusion.getOption("LRthreshold")
  ## Not run: 
  Infusion.options(LRthreshold=- qchisq(0.99,df=1)/2)
  
## End(Not run)


Search within the Infusion package
Search all R packages, documentation and source code

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

Please suggest features or report bugs with the GitHub issue tracker.

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