textsummary: textsummary function

View source: R/lgcpStructures.R

textsummaryR Documentation

textsummary function

Description

A function to print a text description of the inferred paramerers beta and eta from a call to the function lgcpPredictSpatialPlusPars, lgcpPredictAggregateSpatialPlusPars, lgcpPredictSpatioTemporalPlusPars or lgcpPredictMultitypeSpatialPlusPars

Usage

textsummary(obj, digits = 3, scientific = -3, inclIntercept = FALSE, ...)

Arguments

obj

an object produced by a call to lgcpPredictSpatialPlusPars, lgcpPredictAggregateSpatialPlusPars, lgcpPredictSpatioTemporalPlusPars orlgcpPredictMultitypeSpatialPlusPars

digits

see the option "digits" in ?format

scientific

see the option "scientific" in ?format

inclIntercept

logical: whether to summarise the intercept term, default is FALSE.

...

other arguments passed to the function "format"

Value

A text summary, that can be pasted into a LaTeX document and later edited.

See Also

ltar, autocorr, parautocorr, traceplots, parsummary, priorpost, postcov, exceedProbs, betavals, etavals


lgcp documentation built on Oct. 3, 2023, 5:08 p.m.