lrControl {trio} | R Documentation

## Control Parameters for Trio Logic Regression

### Description

Specifies the control parameters for the search algorithms (i.e. either simulated annealing or MCMC) and the logic tree considered when fitting a trio logic regression model.

### Usage

    lrControl(start = 0, end = 0, iter = 0, earlyout = 0, update = 0,
       treesize = 8, opers = 1, minmass = 0, nburn = 1000, hyperpars = 0,
       output = 4)

### Arguments

`start` | a numeric value specifying the upper temperature (on log10 scale) used as start temperature in simulated annealing. Must be larger than `end`. If both `start = 0` and `end = 0`, these temperatures will be chosen automatically (which is not the optimal way to specify these parameters).
`end` | a numeric value specifying the lowest temperature (on log10 scale) used in simulated annealing. Must be smaller than `start`. If both `start = 0` and `end = 0`, these temperatures will be chosen automatically (which is not the optimal way to specify these parameters).
`iter` | the number of iterations used in the (stochastic) search for the best trio logic regression model, i.e. either in simulated annealing (if the argument `search` in `trioLR` or `trioFS` is set to `"sa"`) or in MCMC (if `search = "mcmc"`). If `iter = 0`, `iter` will be chosen automatically (similar to `start` and `end`) when simulated annealing is used, and will be set to `iter = 50000` when MCMC is employed.
`earlyout` | a non-negative integer providing an option to end the search before all `iter` iterations in simulated annealing are considered. If during five consecutive blocks of `earlyout` iterations, 10 or fewer moves proposed in simulated annealing are accepted in each of the blocks, then the search will terminate. Can help to stop the search earlier, when there is no progress in the search anymore. By default, all `iter` iterations are considered.
`update` | the number of iterations in simulated annealing or MCMC after which statistics for the current trio logic regression model are displayed. This argument allows to evaluate the progress in the search for the best trio logic regression model. By default, no updates are shown.
`treesize` | a positive integer specifying the maximum number of leaves allowed in the logic tree of a trio logic regression model.
`opers` | either 1, 2, or 3 specifying if both the AND and the OR operator (`opers = 1`), or only the AND operator (`opers = 2`), or only the OR operator (`opers = 3`) is considered when building the logic tree.
`minmass` | a non-negative integer specifying the number of cases and pseudo-controls for which the logic expression (i.e. the logic tree) needs to be 1 or for which the logic expression needs to be 0 to be considered as a logic tree in the trio logic regression model. By default, `minmass` is either set to 20% of the trios or to 15, whatever is less.
`nburn` | number of initial iterations in MCMC considered as burn-in MC trio logic regression, and therefore, ignored when computing the summaries.
`hyperpars` | a numeric value specifying the hyperparameter for the prior on the model size when performing a MC trio logic regression. More exactly, `hyperpars` is assumed to be log(P(size = k) / P(size = k+1)), where P is the prior on the model size.
`output` | a value specifying which statistics are returned in an MCMC trio logic regression analysis. If `output > 0`, then all fitted models are saved in a text file called "triolrlisting.tmp" in the current working directory. By setting `output < 0`, this can be avoided. If `abs(output) > 1`, bivariate statistics are gathered. If `abs(output) > 2`, trivariate statistics are gathered. Otherwise, only univariate statistics are determined.

### Details

More details on the different control parameters and their specification can be found on the help pages of the functions `logreg.anneal.control`, `logreg.tree.control`, and `logreg.mc.control` for the different types of control parameters available in the `R` package `LogicReg` for a standard logic regressions.

### Value

A list containing all required control parameters.

### Author(s)

Holger Schwender, holger.schwender@udo.edu

### Examples

    # The default values for the parameters in trio logic regression
    # can be specified by
    myControl <- lrControl()

    # If the starting temperature of Simulated Annealing should be set
    # to 100 and the lowest temperature to 0.001, then this can be done by
    myControl2 <- lrControl(start = 2, end = -3)

[Package trio version 3.18.0 Index]