print.cgOneFactorSampleSizeTable: Print a One Factor Sample Size Table object with some format options

Description

Print a cgOneFactorSampleSizeTable object, which contains a table of sample size estimates based on a cgOneFactorFit object.

Usage

## S3 method for class 'cgOneFactorSampleSizeTable':
print(x, title=NULL, endptname=NULL, \dots)

Arguments

A cgOneFactorSampleSizeTable object, typically created by samplesizeTable.cgOneFactorFit.

title

The title for the table. If NULL, it is set to be "Sample Size Table from" concatenated to planningname value in the settings slot of the cgOneFactorSampleSizeTable object.

endptname

The endpoint name, printed out with the table. If NULL, it is set to the endptname value from the settings slot of the cgOneFactorSampleSizeTable object.

...

Additional arguments. Currently one is valid: [object Object]

Value

print.cgOneFactorSampleSizeTable returns invisible. The main purpose is the side effect of printing to the current output connection, which is typically the console.

Details

The object is printed using a mix of cat and print calls. See cgOneFactorSampleSizeTable for details of the *.sstable and other object slots.

Examples

Run this code

data(canine)
canine.data <- prepareCGOneFactorData(canine, format="groupcolumns",
                                      analysisname="Canine",
                                      endptname="Prostate Volume",
                                      endptunits=expression(plain(cm)^3),
                                      digits=1, logscale=TRUE, refgrp="CC")
canine.fit <- fit(canine.data)

canine.samplesize <- samplesizeTable(canine.fit, direction="increasing",
                                     model="olsonly",
                                     mmdvec=c(10, 25, 50, 75, 100), display="none")
print(canine.samplesize)