Learn R Programming

EmpiricalDynamics (version 0.1.2)

generate_report: Generate Analysis Report

Description

Creates a comprehensive report of the entire analysis workflow.

Usage

generate_report(
  results,
  output_file,
  format = c("markdown", "html", "latex"),
  title = "Empirical Dynamics Analysis Report",
  author = "EmpiricalDynamics",
  include_plots = TRUE
)

Value

Path to generated report.

Arguments

results

List containing analysis results with elements:

  • data: Original data frame

  • derivatives: Computed derivatives

  • exploration: Results from explore_dynamics

  • equation: Best fitted equation

  • sde: SDE model (optional)

  • validation: Results from validate_model

output_file

Path for output file (required, no default to comply with CRAN policy).

format

Report format: "markdown", "html", "latex".

title

Report title.

author

Author name.

include_plots

Include diagnostic plots.

Examples

Run this code
# \donttest{
# Toy example to demonstrate report generation
# Using a temporary file to avoid writing to user's working directory
tmp_file <- tempfile("report_example")

# Mock results object
mock_results <- list(
  data = data.frame(time = 1:10, Z = runif(10)),
  equation = stats::lm(Z ~ time, data = data.frame(time = 1:10, Z = runif(10)))
)

# Generate report
report_path <- generate_report(mock_results, output_file = tmp_file, format = "markdown")
if(file.exists(report_path)) unlink(report_path)
# }

Run the code above in your browser using DataLab