check_experiment: Checks if the argument is a valid pirouette experiment.

View source: R/check_experiment.R

check_experimentR Documentation

Checks if the argument is a valid pirouette experiment.

Description

Will stop if not. A valid pirouette experiment can be created by create_experiment.

Usage

check_experiment(experiment)

Arguments

experiment

a pirouette experiment, as can be created by create_experiment

Value

nothing. Will stop if not

Author(s)

Richèl J.C. Bilderbeek

See Also

Use check_experiments to check if an object is a list of experiments

Examples

if (beautier::is_on_ci()) {

  # Check cleanup by other functions
  beastier::check_empty_beaustier_folders()

  check_experiment(create_test_experiment())
  check_experiment(create_test_gen_experiment())
  if (rappdirs::app_dir()$os != "win") {
    check_experiment(create_test_cand_experiment())
  }
}

richelbilderbeek/pirouette documentation built on Oct. 18, 2023, 3:09 p.m.