Skip to content

Commit db8f06d

Browse files
type section in documentation
1 parent 87af388 commit db8f06d

File tree

12 files changed

+16
-16
lines changed

12 files changed

+16
-16
lines changed

R/predictions.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
#' type, but will typically be a string such as: "response", "link", "probs",
5959
#' or "zero". When an unsupported string is entered, the model-specific list of
6060
#' acceptable values is returned in an error message. When `type` is `NULL`, the
61-
#' first entry in the error message is used by default.
61+
#' first entry in the error message is used by default. See the Type section in the documentation below.
6262
#' @param transform A function applied to unit-level adjusted predictions and confidence intervals just before the function returns results. For bayesian models, this function is applied to individual draws from the posterior distribution, before computing summaries.
6363
#'
6464
#' @template references

R/slopes.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
#' type, but will typically be a string such as: "response", "link", "probs",
6060
#' or "zero". When an unsupported string is entered, the model-specific list of
6161
#' acceptable values is returned in an error message. When `type` is `NULL`, the
62-
#' first entry in the error message is used by default.
62+
#' first entry in the error message is used by default. See the Type section in the documentation below.
6363
#' @param slope string indicates the type of slope or (semi-)elasticity to compute:
6464
#' - "dydx": dY/dX
6565
#' - "eyex": dY/dX * Y / X

man-roxygen/type.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' @section Prediction types:
1+
#' @section Types:
22
#'
33
#' The `type` argument determines the scale of the predictions used to compute quantities of interest with functions from the `marginaleffects` package. Admissible values for `type` depend on the model object. When users specify an incorrect value for `type`, `marginaleffects` will raise an informative error with a list of valid `type` values for the specific model object. The first entry in the list in that error message is the default type.
44
#'

man/comparisons.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/get_group_names.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/get_predict.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/get_vcov.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/plot_comparisons.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/plot_predictions.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/plot_slopes.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)