get_gcae_help_text: Get the text of the gcae help file

View source: R/get_gcae_help_text.R

get_gcae_help_textR Documentation

Get the text of the gcae help file

Description

Get the text of the gcae help file

Usage

get_gcae_help_text(gcae_options = create_gcae_options(), verbose = FALSE)

Arguments

gcae_options

options to run GCAE, as created by create_gcae_options

verbose

the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Value

the text of the gcae help file

Author(s)

Richèl J.C. Bilderbeek

Examples

if (plinkr::is_on_ci()) {
  if (has_cloned_gcae_repo()) { # is_gcae_installed is too slow
    get_gcae_help_text()
  }
}

richelbilderbeek/gcaer documentation built on March 25, 2024, 3:08 p.m.