Print a One Factor Sample Size Table object with some format options

Share:

Description

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

Usage

1
2
## S4 method for signature 'cgOneFactorSampleSizeTable'
print(x, title=NULL, endptname=NULL, ...)

Arguments

x

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:

model

For cgOneFactorComparisonsTable objects that have tables derived from classical least squares lm or resistant & robust rlm fits, the following argument values are possible:

"both"

Both the ordinary classical least squares and resistant robust sample size tables are printed. This is the default when both fits are present in the cgOneFactorSampleSizeTable object specified in the x argument. If only one of the two tables were computed, then only that single table is printed.

"olsonly"

Only the ordinary classical least squares group summary table is printed.

"rronly"

Only the resistant & robust group summary table is printed.

Details

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

Value

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

Note

Contact cg@billpikounis.net for bug reports, questions, concerns, and comments.

Author(s)

Bill Pikounis [aut, cre, cph], John Oleynick [aut], Eva Ye [ctb]

See Also

cgOneFactorSampleSizeTable

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
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)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.