print.cgOneFactorDownweightedTable {cg}

Print Downweighted Observations Table object with some format options

Description

Print a cgOneFactorDownweightedTable object, as a table of downweighted observations in a resistant & robust fit from a cgOneFactorFit object.

Usage

## S4 method for signature 'cgOneFactorDownweightedTable'
print(x, digits=NULL, title = NULL, endptname = NULL, ...)

Arguments

x

An object of class cgOneFactorDownweightedTable, typically created by
downweightedTable.cgOneFactorFit.

digits

The number of decimal places to use in the output. If NULL, then the number of decimal places is taken from the cgOneFactorDownweightedTable object.

title

The title printed out with the p-value. If NULL, it is set to be "Downweighted Observations Table from Resistant & Robust Fit" of the analysisname value in the settings of the cgOneFactorDownweightedTable object.

endptname

The endpoint name, printed out with the p-value. If NULL, it is set to the endptname value in the cgOneFactorDownweightedTable object.

...

Additional arguments. None are currently defined for this method.

Details

The object is printed using a mix of cat and print calls. See cgOneFactorDownweightedTable for details of the contents and other object slots.

Value

print.cgOneFactorDownweightedTable returns invisible. The main purpose is the side effect of printing to the current output connection, which is typically the console. If any observations meet the cutoff criteria, a table is displayed.

If no observations meet the cutoff criteria, a text message of table emptiness is displayed instead.

Note

Contact [e-mail] for bug reports, questions, concerns, and comments.

Author(s)

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

See Also

cgOneFactorDownweightedTable

Examples

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.dwtable <- downweightedTable(canine.fit, cutoff=0.95)

downweightedTable(canine.fit, cutoff=0.75) ## No observation
                                           ## downweighted at least 25%