Statistic: Statistic object

Description

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

Usage

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

Arguments

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):

MedianStat: generate the median of the sample defined in the samples argument.
MeanStat: generate the mean of the sample defined in the samples argument.
SdStat: generate the standard deviation of the sample defined in the samples argument.
MinStat: generate the minimum of the sample defined in the samples argument.
MaxStat: generate the maximum of the sample defined in the samples argument.
DiffMeanStat: generate the difference of means between the two samples defined in the samples argument. Two samples must be defined.
EffectSizeContStat: generate the effect size for a continuous endpoint. Two samples must be defined.
RatioEffectSizeContStat: generate the ratio of two effect sizes for a continuous endpoint. Four samples must be defined.
DiffPropStat: generate the difference of the proportions between the two samples defined in the samples argument. Two samples must be defined.
EffectSizePropStat: generate the effect size for a binary endpoint. Two samples must be defined.
RatioEffectSizePropStat: generate the ratio of two effect sizes for a binary endpoint. Four samples must be defined.
HazardRatioStat: generate the hazard ratio of the two samples defined in the samples argument. Two samples must be defined.
EffectSizeEventStat: generate the effect size for a survival endpoint (log of the HR). Two samples must be defined. Two samples must be defined.
RatioEffectSizeEventStat: generate the ratio of two effect sizes for a survival endpoint. Four samples must be defined.
EventCountStat: generate the number of events observed in the sample(s) defined in the samples argument.
PatientCountStat: generate the number of patients observed in the sample(s) defined in the samples argument.

References

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

Examples

Run this code

# 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"))