summary.strata {stratifyR}R Documentation

This method formats and outputs the final results to the R console

Description

This function defines the method for the "strata" class that has been created in the constructor function (strata.data() or strata.distr()) where all computed objects, via other relevant functions, are collated and passed as a list. The function extracts all individual objects from the "strata" class object and combines them into dataframes before writing the formatted outputs to the console. This is used for both cases, depending on either the data or a hypothetical distribution.

Usage

## S3 method for class 'strata'
summary(object, ...)

Arguments

object

A list: An object of class "strata".

...

Any data type: This argument can be any particular argument.

Value

returns the formatted output

Author(s)

Karuna Reddy <karuna.reddy@usp.ac.fj>
MGM Khan <khan_mg@usp.ac.fj>

Examples

## Not run: 
data <- rweibull(1000, shape=2, scale = 1.5)
res <- strata.data(data, h = 2, n=300)
summary(res)

## End(Not run)


[Package stratifyR version 1.0-3 Index]