nonCamelArgs: Return documentation with arguments that are not formatted in...

View source: R/nonCamelArgs.R

nonCamelArgsR Documentation

Return documentation with arguments that are not formatted in strict lower camel case

Description

Return documentation with arguments that are not formatted in strict lower camel case

Usage

nonCamelArgs(
  pkgName,
  allowlist = c("BPPARAM", "FUN", "MARGIN", "USE.NAMES", "X", "do.NULL")
)

Arguments

pkgName

character(1). Package name.

allowlist

character. Character vector of common non-camel argument names to allow.

Value

character. Offending Rd documentation files.

Note

Updated 2023-09-28.


acidgenomics/bb8 documentation built on Feb. 1, 2024, 11:38 a.m.