check_frontmatter: Checks protocol metadata

In inbo/protocolshelper: Helper Functions to Manage Protocols

Checks protocol metadata

Description

This function reads metadata from the yaml front matter stored in the index.Rmd file of a protocol and checks if the metadata format is correct. This function is intended for checking if a protocol is ready to be rendered and published (for instance, it will fail if version number is YYYY.NN.dev).

Usage

check_frontmatter(protocol_code, fail = !interactive())

Arguments

protocol_code	Character string giving the protocol code
fail	Should the function drop an error in case of a problem? Defaults to TRUE in a non-interactive session and FALSE in an interactive session.

Value

A report of all failed checks.

See Also

Other check: check_all(), check_all_author_info(), check_structure(), protocolcheck, validate_orcid()

inbo/protocolshelper documentation built on Sept. 6, 2024, 9:15 p.m.