starve_access: A list of accessor functions for the starve package

In lawlerem/staRVe: Spatio-Temporal Analysis of Research surVEy data

A list of accessor functions for the starve package

Description

These accessor functions are used to extract different components from the objects used in the starve package. This help page is meant only to catalogue all the accessor functions available, and as such will be of limited benefit to package users. Not every accessor function is available for every class implemented in the package. To see which functions are available for a class, and a description of the different components of that class that these functions return, please see the documentation for that class. The main classes implemented in the starve package are dag, long_stars, tracing, and starve.

Usage

convergence(x)

covariance_function(x)

covariance_function(x) <- value

dat(x)

dat(x) <- value

data_predictions(x, ...)

data_predictions(x) <- value

distance_units(x)

distance_units(x) <- value

distances(x)

edges(x)

fixed_effects(x)

fixed_effects(x) <- value

formula(x, ...)

formula(x) <- value

graph(x)

hess_time(x)

link_function(x)

link_function(x) <- value

locations(x)

locations(x) <- value

max_distance(x)

max_distance(x) <- value

n_neighbours(x)

opt_time(x)

parameter_covariance(x)

parameter_hessian(x)

parameters(x)

parameters(x) <- value

persistent_graph(x)

pg_re(x)

pg_re(x) <- value

random_effects(x)

response_distribution(x)

response_distribution(x) <- value

response_parameters(x)

response_parameters(x) <- value

sdr_time(x)

settings(x)

space_parameters(x)

space_parameters(x) <- value

tg_re(x)

tg_re(x) <- value

time_effects(x)

time_effects(x) <- value

time_parameters(x)

time_parameters(x) <- value

timing(x)

tracing(x)

transient_graph(x)

values(x)

values(x) <- value

Arguments

x	An object
value	A replacement value

Functions

• convergence(): Get convergence message

• covariance_function(): Get covariance function

• covariance_function(x) <- value: Set covariance function

• dat(): Get data

• dat(x) <- value: Set data

• data_predictions(): Get data predictions

• data_predictions(x) <- value: Set data

• distance_units(): Get distance units

• distance_units(x) <- value: Set distance units

• distances(): Get distances

• edges(): Get edges

• fixed_effects(): Get fixed effects

• fixed_effects(x) <- value: Set fixed effects

• formula(): Get model formula

• formula(x) <- value: Set model formula

• graph(): Get graph

• hess_time(): Get hessian computation time

• link_function(): Get link function

• link_function(x) <- value: Set link function

• locations(): Get locations

• locations(x) <- value: Get locations

• max_distance(): Get max distance

• max_distance(x) <- value: Set max distance

• n_neighbours(): Get n_neighbours setting

• opt_time(): Get optimization time

• parameter_covariance(): Get parameter estimator covariance matrix

• parameter_hessian(): Get parameter estimator hessian matrix

• parameters(): Get parameters

• parameters(x) <- value: Set parameters

• persistent_graph(): Get persistent graph

• pg_re(): Get persistent graph random effects

• pg_re(x) <- value: Set persistent graph random effects

• random_effects(): Get random effects

• response_distribution(): Get response distribution

• response_distribution(x) <- value: Set response distribution

• response_parameters(): Get response distribution parameters

• response_parameters(x) <- value: Set response distribution parameters

• sdr_time(): Get standard error computation time

• settings(): Get settings

• space_parameters(): Get spatial parameters

• space_parameters(x) <- value: Set spatial parameters

• tg_re(): Get transient graph random effects

• tg_re(x) <- value: Set transient graph random effects

• time_effects(): Get time effects

• time_effects(x) <- value: Set time effects

• time_parameters(): Get time parameters

• time_parameters(x) <- value: Set time parameters

• timing(): Get model computation times

• tracing(): Get tracing information

• transient_graph(): Get transient graph

• values(): Get values

• values(x) <- value: Set values

See Also

dag, long_stars, tracing, starve

lawlerem/staRVe documentation built on Oct. 9, 2024, 4:48 a.m.