CrcRiskParams-class: Class that hold parameters used to model a persons risk...

Description Details Fields See Also

Description

This class contains a number of parameters utilised by CrCRisk to model/generate a person's risk factors, and by other classes in the CrcSpinModel family.

Details

Upon object initialisation via $new() the parameters take on hard default values (see initialize which can later be changed via the setParams method.

Storing the risk factor modeling parameters independent to the risk factor class allows driver classes to set population wide modeling parameters without needing to interface the risk factor class of every individual directly, and to pass the parameters to other classes if required.

Fields

baseline_mean

Mean used to draw base line risk factor.

baseline_sd

Standard deviation used to draw base line risk factor.

sex_linked_mean

Mean used to draw gender linked risk factor.

sex_linked_sd

Standard deviation used to draw gender linked risk factor.

age_mean

Mean used to draw age risk factor.

age_sd

Standard deviation used to draw age risk factor.

See Also

Other CrcSpinModel_classes: AdenomaParams, AdenomaParams-class; Adenoma, Adenoma-class; CrcRisk, CrcRisk-class; CrcSpinModel, CrcSpinModel-class; Risk, Risk-class


csiro-crc-spin/SpinModels documentation built on May 12, 2017, 12:26 p.m.