print.cgPairedDifferenceDownweightedTable {cg}R Documentation

Print Downweighted Observations Table object with some format options

Description

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

Usage

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

Arguments

x

An object of class cgPairedDifferenceDownweightedTable, typically created by downweightedTable.cgPairedDifferenceFit.

digits

The number of decimal places to use in the output. If NULL, then the number of decimal places is taken from the cgPairedDifferenceDownweightedTable 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 cgPairedDifferenceDownweightedTable object.

endptname

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

...

Additional arguments. None are currently defined for this method.

Details

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

Value

print.cgPairedDifferenceDownweightedTable 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 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

cgPairedDifferenceDownweightedTable

Examples


data(anorexiaFT)

anorexiaFT.data <- prepareCGPairedDifferenceData(anorexiaFT, format="groupcolumns",
                                                 analysisname="Anorexia FT",
                                                 endptname="Weight",
                                                 endptunits="lbs",
                                                 expunitname="Patient",
                                                 digits=1,
                                                 logscale=TRUE)

anorexiaFT.fit <- fit(anorexiaFT.data)

anorexiaFT.dw <- downweightedTable(anorexiaFT.fit, cutoffwt=0.25, display='none') 

print(anorexiaFT.dw)  ## No observation


[Package cg version 1.0-3 Index]