Statistic: Statistic object

Description Usage Arguments Details References See Also Examples

View source: R/Statistic.R

Description

This function creates an object of class Statistic which can be added to an object of class AnalysisModel.

Usage

1
Statistic(id, method, samples, par = NULL)

Arguments

id

defines the ID of the statistic.

method

defines the type of statistics/method for computing the statistic.

samples

defines a list of sample(s) (defined in the data model) to be used by the statistic method.

par

defines the parameter(s) of the method for computing the statistic.

Details

Objects of class Statistic are used in objects of class AnalysisModel to define the statistics to produce. Several objects of class Statistic can be added to an object of class AnalysisModel.

method argument defines the statistical method. Several methods are already implemented in the Mediana package (listed below, along with the required parameters to define in the par parameter):

References

http://gpaux.github.io/Mediana/

See Also

See Also AnalysisModel.

Examples

1
2
3
4
5
6
7
8
# Analysis model
analysis.model = AnalysisModel() +
                 Test(id = "Placebo vs treatment",
                      samples = samples("Placebo", "Treatment"),
                      method = "TTest") +
                 Statistic(id = "Mean Treatment",
                           method = "MeanStat",
                           samples = samples("Treatment"))

gpaux/Mediana documentation built on May 31, 2021, 1:22 a.m.