read_checklist: Read the check list file from a package

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

Read the check list file from a package

Description

The checklist package stores configuration information in the checklist.yml file in the root of a project. This function reads this configuration. It is mainly used by the other functions inside the package. If no checklist.yml file is found at the path, the function walks upwards through the directory structure until it finds such file. The function returns an error when it reaches the root of the disk without finding a checklist.yml file.

Usage

read_checklist(x = ".")

Arguments

x	Either a checklist object or a path to the source code. Defaults to ..

Value

A checklist object.

See Also

Other both: add_badges(), check_filename(), check_lintr(), check_spelling(), custom_dictionary(), default_organisation(), print.checklist_spelling(), read_organisation(), update_citation(), write_checklist(), write_citation_cff(), write_organisation(), write_zenodo_json()

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.