diagnostic_params: Shared parameters and return values for diagnostic helpers
In dfeR: Common Department for Education Analysis Tasks
diagnostic_params R Documentation
Shared parameters and return values for diagnostic helpers
Description
Internal documentation object that holds the parameters and return-value
wording reused across diagnostic_test() and the check_*() helpers. It is
not exported and is not intended to be called - it exists only as a single
source of truth for roxygen2::roxygen2-package to inherit from via
@inheritParams and @inherit.
Arguments
clean
If TRUE, attempt to clean detected issues. Default FALSE.
Details
Each check returns a list including a status field, one of "pass",
"fail", "fixed" or "info", depending on the outcome of the check.
dfeR documentation built on Sept. 24, 2026, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| diagnostic_params | R Documentation |
Shared parameters and return values for diagnostic helpers
Description
Internal documentation object that holds the parameters and return-value
wording reused across diagnostic_test() and the check_*() helpers. It is
not exported and is not intended to be called - it exists only as a single
source of truth for roxygen2::roxygen2-package to inherit from via
@inheritParams and @inherit.
Arguments
clean |
If |
Details
Each check returns a list including a status field, one of "pass",
"fail", "fixed" or "info", depending on the outcome of the check.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.