hyper.fit (version 1.1.1)

hyper.summary: Summary function for hyper.fit object

Description

Prints out basic summary information for hyper.fit objects output by the hyper.fit function.

Usage

# S3 method for hyper.fit
summary(object, ...)

Arguments

object

An object of class hyper.fit. This is the only structure that needs to be provided when executing summary(fitobj) class dependent plotting, which will use the summary.hyper.fit function.

…

Arguments passed to summary function.

Value

Prints various summary outputs.

Details

Outputs basic summary of the hyper.fit output.

References

Robotham, A.S.G., & Obreschkow, D., PASA, in press

See Also

hyper.basic, hyper.convert, hyper.data, hyper.fit, hyper.plot, hyper.sigcor, hyper.summary

Examples

# NOT RUN {
#### Example using 6dFGS Fundamental Plane data ####

FP6dFGS=read.table(system.file('data/FP6dFGS.tab', package='hyper.fit'), header=TRUE)
fitFP6dFGSw=hyper.fit(FP6dFGS[,c('logIe_J', 'logsigma', 'logRe_J')],
vars=FP6dFGS[,c('logIe_J_err', 'logsigma_err', 'logRe_J_err')]^2, weights=FP6dFGS[,'weights'],
coord.type='alpha', scat.type='vert.axis')
summary(fitFP6dFGSw)

# }