Function Reference

Complete documentation for all exported functions in bgms.

bgm() and bgmCompare() return S7 objects (classes bgms and bgmCompare). Standard methods like print(), summary(), and coef() work through S3 dispatch for compatibility with base R generics.

Core Functions

Function	Description
`bgm()`	Estimates the main effects and pairwise interactions of a network using a Bayesian framework.
`bgmCompare()`	Estimates whether edge weights and category thresholds differ across networks of two different groups.

Methods

Method	Description
`print()`	Minimal console output for a fitted model
`summary()`	Summary statistics for posterior samples
`coef()`	Extract posterior means of model parameters
`predict()`	Predict new observations from a fitted model
`simulate()`	Simulate datasets from the posterior distribution
`simulate_mrf()`	Simulate observations from a Markov Random Field

Extractor Functions

Function	Description
`extract_arguments()`	Retrieve the arguments used when fitting a model
`extract_main_effects()`	Extract posterior samples of category threshold parameters
`extract_pairwise_interactions()`	Extract posterior samples of partial association parameters
`extract_indicators()`	Extract posterior samples of edge or difference indicators
`extract_posterior_inclusion_probabilities()`	Compute posterior inclusion probabilities from indicator samples
`extract_indicator_priors()`	Retrieve prior inclusion probabilities for indicators
`extract_group_params()`	Extract group-specific parameters from a `bgmCompare` fit
`extract_sbm()`	Extract stochastic block model assignments and probabilities
`extract_ess()`	Compute effective sample sizes for model parameters
`extract_rhat()`	Compute split-R-hat convergence diagnostics
`extract_precision()`	Extract posterior mean precision matrix (GGM / continuous block)
`extract_partial_correlations()`	Extract posterior mean partial correlation matrix
`extract_log_odds()`	Extract posterior mean log-odds matrix (OMRF / discrete block)

Datasets

Dataset	N	Items	Type	Description
`ADHD`	355	18	Binary	ADHD symptom ratings for children
`Boredom`	986	8	Ordinal	Boredom proneness scores (7-point Likert)
`Wenchuan`	362	17	Ordinal	PTSD symptom ratings (5-point Likert)