chk_requirements: Check R set up before a class

View source: R/checker.R

chk_requirementsR Documentation

Check R set up before a class

Description

Checks that the required versions of 'R', 'RStudio', 'R' packages and other dependencies are installed.

Usage

chk_requirements(path = system.file("default.yaml", package = "checker"))

Arguments

path

path to yaml file. Defaults to a file that comes with the package.

Details

chk_requirements() checks that the computer set up before class. It check

  • 'R' version

  • 'RStudio' version

  • 'RStudio' options

  • 'R' packages are installed (with version if necessary)

  • 'git' version

  • 'quarto' version

These requirements are specified in a yaml file specified by the path argument which can be on the users computer or at a URL. If not set, the function defaults to using a built-in yaml file, which may not require the latest version.

Value

No return value, output is printed

Examples

chk_requirements()

checker documentation built on April 26, 2023, 5:11 p.m.