get_folder_cheers_classifications: Get cheers classification tags from a given folder

View source: R/cheers_checker.R

get_folder_cheers_classificationsR Documentation

Get cheers classification tags from a given folder

Description

For a provided folder path, identify the cheers classification tags and the function names that follow them.

Usage

get_folder_cheers_classifications(path, cheers_pattern, path_ignore = "tests/")

Arguments

path

A string containing the filepath to the folder to be checked

cheers_pattern

A string containing the roxygen tag for cheers which is used as an identifier

path_ignore

A string containing the pattern to identify files to ignore

Value

A list containing the cheers tags and the function names that follow them

See Also

Other cheers: get_file_cheers_classifications()


assertHE documentation built on June 8, 2025, 10:08 a.m.