contains_roxygen: Check if a text file or character string contains Roxygen2...

View source: R/contains_roxygen.R

contains_roxygenR Documentation

Check if a text file or character string contains Roxygen2 documentation

Description

This function parses a text file or a character string and returns TRUE if it contains Roxygen2 documentation. It uses a regex pattern to identify possible Roxygen2 documentation lines.

Usage

contains_roxygen(input)

Arguments

input

A character string specifying the path to the text file, or a character string containing the text to be checked for Roxygen2 documentation.

Value

A logical value (TRUE or FALSE) indicating whether the input contains Roxygen2 documentation.


TheOpenAIR documentation built on April 27, 2023, 5:10 p.m.