use_biocompute: Use whirl to create biocompute logs

In whirl: Log Execution of Scripts

Use whirl to create biocompute logs

Description

Utility function to setup execution with whirl in your project suitable for creating biocompute logs with write_biocompute():

1. Creates configuration file (default ⁠_whirl.yml⁠) with default values for the biocompute metadata.

2. Updates .gitignore to not include log files

See vignette("whirl") for how to specify paths inside the configuration file.

Usage

use_biocompute(
  config_file = "_whirl.yml",
  parametrics_file = "_parametrics.yml"
)

Arguments

config_file	Path to the whirl config file, relative to the project
parametrics_file	Path to the biocompute parametrics file, relative to the project

whirl documentation built on Aug. 8, 2025, 7:22 p.m.