validate_Rd: Function to validate terms in the dictionary.

View source: R/validate_Rd.R

validate_RdR Documentation

Function to validate terms in the dictionary.

Description

The dictionary terms are written in R documentation (Rd) format. This function reads the Rd file using the tools::parse_Rd function validate the information in each section (e.g., examples, rationale, range of possible values, etc.).

Usage

validate_Rd(Rd_file)

Arguments

Rd_file

a Rd filename to use as input.

Value

a message if the term passes all validations.


nmfs-fish-tools/data_dictionary documentation built on July 27, 2024, 12:20 p.m.