R Validation Hub Report Quarto Extension

Quarto-powered tools for generating R package validation assessments and reports.

Quick Start

Precalculated Metrics

By precalculating metrics, we can derive all the inputs for our report outside the actual reporting engine. This can make it far easier to control the execution environment and can be much easier to debug.

library(val.meter)

options(
  # constrain console output width for cleaner logs
  width = 80L,
  # enable logs for richer reports
  val.meter.logs = TRUE,
  # opt-in to more permissions to gather more metrics
  val.meter.policy = policy(permissions = TRUE)
)

# derive our package metrics
p <- pkg("../val.meter")
metrics(p)

saveRDS(p, "metrics.Rds")

quarto render -P package=metrics.Rds

Calculate & Render

Warning

Work-in-progress

This method is less resilient to erroring metrics and missing execution permissions. Our goal is to build the most useful report given the provided inputs.

Important

This method is easiest to get started, but hardest to debug and ensure good reproducibility.

Looking for reproducibility? Head to (the section on using pre-calculated metrics)[#metrics-precalculated].

If we pass a package name to quarto parameter package the template will derive metrics during the report generation as they are needed.

This is equivalent to val.meter::pkg(params$package), and comes with all the caveats associated with that. The package will be sourced from your local library or default package repositories.

If we want to pass extra options, such as permitting val.meter to execute package code, we need to pass those options through quarto as well:

quarto render \
  -P package=praise \
  -P options='val.meter.policy: "!expr val.meter::policy(permissions = TRUE)"'

Tip

Rendering using val.report coming soon.