md_run: Run study design workflow

View source: R/fct_main.R

md_runR Documentation

Run study design workflow

Description

Executes a complete simulation and analysis workflow for an animal movement study design prepared using md_prepare(). This function simulates telemetry data, fits movement models, estimates home ranges and/or movement speeds, and stores all results in the returned object. Progress and timing messages are printed by default.

Usage

md_run(design, trace = TRUE)

Arguments

design

An object of class movedesign (and movedesign_input), as returned by md_prepare(), containing all study design parameters and data.

trace

Logical. If TRUE (default), print progress and timing messages to the console.

Details

This function ensures reproducibility by saving all random seeds and intermediate results. Progress and timing messages help track the simulation workflow.

Typical workflow:

  • Prepare a study design with md_prepare().

  • Run all simulations and analyses with md_run().

  • Summarize or plot outputs from the returned object.

Value

An updated movedesign object (subclass movedesign_preprocess) containing all simulation and outputs components:

  • simList: List of simulated telemetry datasets, one per individual.

  • seedList: List of random seeds used for reproducibility.

  • simfitList: List of fitted movement models for each simulation.

  • akdeList: List of home range (AKDE) estimates, present if the hr target was listed in set_target.

  • ctsdList: List of continuous-time speed and distance (CTSD) estimates, present if the ctsd target was listed in set_target.

See Also

md_prepare(), md_replicate(), md_check(), md_plot()

Examples

if(interactive()) {
input <- md_prepare(
  data = buffalo,
  models = models,
  species = "buffalo",
  n_individuals = 5,
  dur = list(value = 1, unit = "month"),
  dti = list(value = 1, unit = "day"),
  add_individual_variation = TRUE,
  set_target = "hr",
  which_meta = "mean"
)
output <- md_run(input)
}


movedesign documentation built on Aug. 8, 2025, 6:47 p.m.