createCase: Simulate Cases

Description Usage Arguments Details Value Note Author(s) References See Also Examples

View source: R/createCase.R

Description

Numerical feature simulation for positive samples. Called by createData.

Usage

1
2
createCase(subtype, upper.mean, lower.mean, upper.sd, lower.sd, n.features, 
subtype1.feats = 1:5, subtype2.feats = 6:10, subtype3.feats = 11:15)

Arguments

subtype

Numeric number indicating which subtype to simulate. Currently supports three subtype: 1, 2 or 3.

upper.mean

The mean of the upper component of the bimodal Gaussian distribution from which features are simulated.

lower.mean

The mean of the lower component of the bimodal Gaussian distribution from which features are simulated.

upper.sd

The standard deviation of the upper component of the bimodal Gaussian distribution from which features are simulated.

lower.sd

The standard deviation of the lower component of the bimodal Gaussian distribution from which features are simulated.

n.features

Number of features to simulate.

subtype1.feats

Numeric vector representing the indices of features that define subtype 1.

subtype2.feats

Numeric vector representing the indices of features that define subtype 2.

subtype3.feats

Numeric vector representing the indices of features that define subtype 3.

Details

Simulations support 3 subtypes, each defined by 5 different features.

Subtype 1 is defined as having the first 3 subtype1.feats and at least one of the next 2 subtype1.feats simulated from the upper component of the bimodal Gaussian distribution.

Subtype 2 is defined as having all 5 subtype2.feats simulated from the upper component.

Subtype 3 is defined as having the first 4 subtype3.feats simulated from the upper component and and the last subtype3.feats simulated from the lower component.

Value

Returns a vector of simulated features

Note

createCase is not meant to be called alone. It is designed as a helper function for createData.

Author(s)

Michelle Saul

References

ADD REFERENCE

See Also

createData

Examples

1
2
3
4
5
6
# Toy Example 
case <- createCase(subtype = 1, upper.mean = 13, lower.mean = 5, 
upper.sd = 1, lower.sd = 1, n.features = 20, 
                        subtype1.feats = 1:5,
                        subtype2.feats = 6:10,
                        subtype3.feats = 11:15)

FamilyRank documentation built on Feb. 5, 2021, 9:05 a.m.