Skip to content

Commit

Permalink
tag internal functions
Browse files Browse the repository at this point in the history
  • Loading branch information
przybal2 committed Jun 12, 2024
1 parent 526e340 commit a84c8cd
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions R/sanitize.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#' \link[stats]{glm} with binomial family canonical link is supported.
#' @param ... arguments passed to or from other methods.
#' @return if model is non-compliant will throw warnings or errors.
#' @keywords internal
sanitize_model <- function(model, ...) {
UseMethod("sanitize_model")
}
Expand All @@ -24,6 +25,7 @@ sanitize_model <- function(model, ...) {
#' @param ... ignored.
#' @return if model is non-compliant will throw warnings or errors.
#' @importFrom stats model.frame model.matrix terms
#' @keywords internal
#' @export
#' @examples \dontrun{
#' fit1 <- glm(aval ~ trtp + bl_cov, family = "binomial", data = trial01)
Expand Down Expand Up @@ -98,6 +100,7 @@ sanitize_model.default <- function(model, trt, ...) {
#' @param model an \link[stats]{glm} model object.
#' @param trt the name of the treatment variable on the right-hand side of the glm formula.
#' @return if model and variable are non-compliant, will throw warnings or error.
#' @keywords internal
sanitize_variable <- function(model, trt) {
data <- .get_data(model)

Expand Down
1 change: 1 addition & 0 deletions man/sanitize_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/sanitize_model.glm.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/sanitize_variable.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a84c8cd

Please sign in to comment.