lgpfit-class: An S4 class to represent the output of the 'lgp' function

In jtimonen/lgpr: Longitudinal Gaussian Process Regression

An S4 class to represent the output of the lgp function

Description

An S4 class to represent the output of the lgp function

Usage

## S4 method for signature 'lgpfit'
show(object)

## S4 method for signature 'lgpfit'
component_names(object)

## S4 method for signature 'lgpfit'
num_components(object)

## S4 method for signature 'lgpfit'
postproc(object, verbose = TRUE)

## S4 method for signature 'lgpfit'
contains_postproc(object)

## S4 method for signature 'lgpfit'
clear_postproc(object)

## S4 method for signature 'lgpfit'
get_model(object)

## S4 method for signature 'lgpfit'
get_stanfit(object)

## S4 method for signature 'lgpfit'
is_f_sampled(object)

## S4 method for signature 'lgpfit,missing'
plot(x, y)

Arguments

object	The object for which to apply a class method.
verbose	Can the method print any messages?
x	an lgpfit object to visualize
y	unused argument

Methods (by generic)

• show(lgpfit): Print information and summary about the fit object.

• component_names(lgpfit): Get names of model components.

• num_components(lgpfit): Get number of model components. Returns a positive integer.

• postproc(lgpfit): Apply postprocessing. Returns an updated lgpfit object (copies data).

• contains_postproc(lgpfit): Check if object contains postprocessing information.

• clear_postproc(lgpfit): Returns an updated (copies data) lgpfit object without any postprocessing information.

• get_model(lgpfit): Get the stored lgpmodel object. Various properties of the returned object can be accessed as explained in the documentation of lgpmodel.

• get_stanfit(lgpfit): Get the stored stanfit object. Various properties of the returned object can be accessed or plotted as explained here or in the documentation of stanfit.

• is_f_sampled(lgpfit): Determine if inference was done by sampling the latent signal f (and its components).

• plot(x = lgpfit, y = missing): Visualize parameter draws using plot_draws.

Slots

stan_fit

An object of class stanfit.

model

An object of class lgpmodel.

num_draws

Total number of parameter draws.

postproc_results

A named list containing possible postprocessing results.

See Also

For extracting parameter draws, see get_draws, or the rstan methods for stanfit objects.

For more detailed plotting functions, see plot_draws, plot_beta, plot_warp, plot_effect_times

jtimonen/lgpr documentation built on Oct. 12, 2023, 11:13 p.m.