Skip to content

Commit

Permalink
Merge branch 'main' into strengejacke/issue937
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke authored Oct 22, 2024
2 parents 329033c + 0ee810a commit ca8ea18
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
9 changes: 5 additions & 4 deletions R/find_transformation.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@
#' or exp-transforming, was applied to the response variable (dependent
#' variable) in a regression formula. Currently, following patterns are
#' detected: `log`, `log1p`, `log2`, `log10`, `exp`, `expm1`, `sqrt`,
#' `log(x+<number>)`, `log-log`, `power` (e.g. to 2nd power, like `I(x^2)`),
#' `inverse` (like `1/y`), `scale` (e.g., `x/3`), and `box-cox` (e-g-,
#' `log(y+<number>)`, `log-log`, `power` (e.g. to 2nd power, like `I(y^2)`),
#' `inverse` (like `1/y`), `scale` (e.g., `y/3`), and `box-cox` (e-g-,
#' `(y^lambda - 1) / lambda`).
#'
#' @param x A regression model or a character string of the response value.
#' @param x A regression model or a character string of the formulation of the
#' response variable.
#' @param ... Currently not used.
#'
#' @return A string, with the name of the function of the applied transformation.
#' Returns `"identity"` for no transformation, and e.g. `"log(x+3)"` when
#' Returns `"identity"` for no transformation, and e.g. `"log(y+3)"` when
#' a specific values was added to the response variables before
#' log-transforming. For unknown transformations, returns `NULL`.
#'
Expand Down
6 changes: 3 additions & 3 deletions man/find_transformation.Rd

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

0 comments on commit ca8ea18

Please sign in to comment.