get_fitted_effect: Access fitted effect l

View source: R/operation_on_susiF_obj.R

get_fitted_effectR Documentation

Access fitted effect l

Description

Access fitted effect

Usage

get_fitted_effect(obj, l, cred_band, alpha, ...)

## S3 method for class 'susiF'
get_fitted_effect(obj, l = 1, cred_band = FALSE, alpha = 0.01, ...)

Arguments

obj

A fitted object.

l

Effect of interest.

cred_band

Logical, default set to 'FALSE'. If 'TRUE', also returns the credible band.

alpha

Numerical, defined as 1 - conf_level set to obtain 0.99 confidence level by default.

...

Other arguments.

Details

Retrieves the estimated effect from a fitted model.

Value

The fitted effect.


stephenslab/susiF.alpha documentation built on March 1, 2025, 4:28 p.m.