bsub {multilevelcoda} | R Documentation |
Between-person Simple Substitution
Description
This function is an alias of substitution
to estimates the the difference in an outcome
when compositional parts are substituted for specific unit(s) at between level
using a single reference composition (e.g., compositional mean at sample level).
It is recommended that users run substitution model using the substitution
function.
Usage
bsub(
object,
delta,
basesub,
summary = TRUE,
ref = "grandmean",
level = "between",
weight = "equal",
aorg = TRUE,
scale = c("response", "linear"),
comparison = "one-to-one",
cores = NULL,
...
)
Arguments
object |
A fitted |
delta |
A integer, numeric value or vector indicating the amount of substituted change between compositional parts. |
basesub |
A base substitution.
Can be a |
summary |
A logical value to obtain summary statistics instead of the raw values. Default is |
ref |
Either a character value or vector or a dataset.
Can be |
level |
A character string or vector.
Should the estimate of multilevel models focus on the |
weight |
A character value specifying the weight to use in calculation of the reference composition.
If |
aorg |
A logical value to obtain (a)verage prediction (o)ver the (r)eference (g)rid.
Should the estimate at each level of the reference grid ( |
scale |
Either |
comparison |
internally used only. |
cores |
Number of cores to use when executing the chains in parallel,
we recommend setting the |
... |
currently ignored. |
Value
A list containing the results of multilevel compositional substitution model. The first six lists contain the results of the substitution estimation for a compositional part.
Mean |
Posterior means. |
CI_low and CI_high |
95% credible intervals. |
Delta |
Amount substituted across compositional parts. |
From |
Compositional part that is substituted from. |
To |
Compositional parts that is substituted to. |
Level |
Level where changes in composition takes place. |
Reference |
Either |
See Also
Examples
if(requireNamespace("cmdstanr")){
cilr <- complr(data = mcompd, sbp = sbp,
parts = c("TST", "WAKE", "MVPA", "LPA", "SB"), idvar = "ID", total = 1440)
# model with compositional predictor at between and between-person levels
m <- brmcoda(complr = cilr,
formula = Stress ~ bilr1 + bilr2 + bilr3 + bilr4 +
wilr1 + wilr2 + wilr3 + wilr4 + Female + (1 | ID),
chain = 1, iter = 500,
backend = "cmdstanr")
subm <- bsub(object = m, basesub = psub, delta = 5)
}