Learn R Programming

mcmodule (version 1.1.1)

trial_totals: Trial Probability and Expected Counts

Description

Calculates probabilities and expected counts across hierarchical levels (trial, subset, set) in a structured population. Uses trial probabilities and handles nested sampling with conditional probabilities.

Usage

trial_totals(
  mcmodule,
  mc_names,
  trials_n,
  subsets_n = NULL,
  subsets_p = NULL,
  name = NULL,
  prefix = NULL,
  combine_prob = TRUE,
  all_suffix = NULL,
  level_suffix = c(trial = "trial", subset = "subset", set = "set"),
  mctable = set_mctable(),
  agg_keys = NULL,
  agg_suffix = NULL,
  keep_variates = FALSE,
  summary = TRUE,
  data_name = NULL
)

Value

Updated mcmodule object containing:

  • Combined node probabilities

  • Probabilities and counts at trial level

  • Probabilities and counts at subset level

  • Probabilities and counts at set level

Arguments

mcmodule

mcmodule object containing input data and node structure

mc_names

Vector of node names to process

trials_n

Trial count column name

subsets_n

Subset count column name (optional)

subsets_p

Subset prevalence column name (optional)

name

Custom name for output nodes (optional)

prefix

Prefix for output node names (optional)

combine_prob

Combine probability of all nodes assuming independence (default: TRUE)

all_suffix

Suffix for combined node name (default: "all")

level_suffix

A list of suffixes for each hierarchical level (default: c(trial="trial",subset="subset",set="set"))

mctable

Data frame containing Monte Carlo nodes definitions (default: set_mctable())

agg_keys

Column names for aggregation (optional)

agg_suffix

Suffix for aggregated node names (default: "hag")

keep_variates

whether to preserve individual values (default: FALSE)

summary

Include summary statistics if TRUE (default: TRUE)

data_name

Data name used to create trials_n, subsets_n and subsets_p nodes if they don't exist in mcmodule (optional)

Examples

Run this code
imports_mcmodule <- trial_totals(
  mcmodule = imports_mcmodule,
  mc_names = "no_detect_a",
  trials_n = "animals_n",
  subsets_n = "farms_n",
  subsets_p = "h_prev",
  mctable = imports_mctable
)
print(imports_mcmodule$node_list$no_detect_a_set$summary)

Run the code above in your browser using DataLab