summary.Pistar: Summarizing '"Pistar"' Objects

summary.PistarR Documentation

Summarizing "Pistar" Objects

Description

summary method for class "Pistar"

Usage

## S4 method for signature 'Pistar'
summary(object, conf = 0.95, pi_side = NULL, par_side = NULL,
        lower = NULL, upper = NULL, bias = FALSE, ...)

## S4 method for signature 'SummaryPistar'
print(x, digits = 2, ...)	

Arguments

object

an object of class "pistar"

x

an object of class "summary.pistar"

digits

integer indicating the number of decimal places to print

conf

Confidence level expressed as a number between 0 and 1. e.g. for a 95% confidence interval supply 0.95

pi_side

Sidedness of c.i. for pi*. NULL for a two-sided c.i., "lower" or "upper" for a one-sided interval. "auto" selects "lower" if the estimate is larger than 0 and "upper" if it is smaller than 0.

par_side

Sidedness of c.i. for reported estimates of parameters other than pi*. NULL for a two-sided c.i., "lower" or "upper" for a one-sided interval. "auto" selects "lower" if the estimate is larger than 0 and "upper" if it is smaller than 0.

lower

lowest possible value for one-sided c.i.

upper

largest possible value for one-sided c.i.

bias

logical: Apply bias correction? Bias correction currently not implemented.

...

arguments to be passed to methods; not used

Value

Object of class "SummaryPistar", a list with the following slots

oldcall

the matched call inherited from the input object of class "Pistar"

pred

inherited from the input object of class "Pistar"

est

A data.frame with the parameter estimates, optionally also with standard errors, lower and upper endpoints of c.i., sidedness of the c.i., and bias (the last is not currently fully implemented)

Author(s)

Juraj Medzihorsky

Examples

	#	create data:
	H <- matrix((1:4)*1e1, byrow=TRUE, ncol=2)

	#	pi* for independence in a 2-by-2 table
	h <- pistar(proc="2by2", data=H, alpha=1, jack=TRUE)

	#	print 'pistar' object
	h

	#	summarize 'pistar' object
	s <- summary(h)

	#	print 'summary.pistar' object
	s

	#	print the 'summary.pistar' object to 4 decimal places
	print(s, digits=4)

	#	compare the structure of the objects
	str(h)
	str(s)


jmedzihorsky/pistar documentation built on June 4, 2022, 9:58 a.m.