Skip to content

Commit 503f7bc

Browse files
committed
document null argument options
1 parent 426ae82 commit 503f7bc

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

R/hypothesize.R

+13
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@
99
#' @param x A data frame that can be coerced into a [tibble][tibble::tibble].
1010
#' @param null The null hypothesis. Options include `"independence"`,
1111
#' `"point"`, and `"paired independence"`.
12+
#' \itemize{
13+
#' \item `independence`: Should be used with both a `response` and `explanatory`
14+
#' variable. Indicates that the values of the specified `response` variable
15+
#' are independent of the associated values in `explanatory`.
16+
#' \item `point`: Should be used with only a `response` variable. Indicates
17+
#' that a point estimate based on the values in `response` is associated
18+
#' with a parameter. Sometimes requires supplying one of `p`, `mu`, `med`, or
19+
#' `sigma`.
20+
#' \item `paired independence`: Should be used with only a `response` variable
21+
#' giving the pre-computed difference between paired observations. Indicates
22+
#' that the order of subtraction between paired values does not affect the
23+
#' resulting distribution.
24+
#' }
1225
#' @param p The true proportion of successes (a number between 0 and 1). To be used with point null hypotheses when the specified response
1326
#' variable is categorical.
1427
#' @param mu The true mean (any numerical value). To be used with point null

man/hypothesize.Rd

+14-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/observe.Rd

+14-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)