Skip to content

Commit

Permalink
Fix documentation for GIGS package-level options
Browse files Browse the repository at this point in the history
  • Loading branch information
Parker committed Nov 15, 2024
1 parent 8446089 commit 0241631
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
5 changes: 3 additions & 2 deletions R/gigs_options.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,20 @@
#'
#' This argument will not accept an integer in place of a logical value.
#' @param new_value A single case-sensitive character variable. For all options
#' **except** "handle_unused_levels", this should be one of:
#' **except** `"handle_unused_levels"`, this should be one of:
#' * `"quiet"` - gigs will replace invalid vector elements with `NA` quietly.
#' * `"warn"` - gigs will replace invalid vector elements with `NA` loudly.
#' * `"error"` - gigs will throw informative errors if any invalid inputs are
#' encountered.
#'
#' For "handle_unused_levels", `new_value` should be one of:
#' * `"keep_quiet"` - Keep unused factor levels, and don't issue a warning.
#' * `"keep_warn"` - Keep unused factor levels, whilst issuing a warning.
#' * `"drop_quiet"` - Drop unused factor levels, and don't issue a warning.
#' * `"drop_warn"` - Drop unused factor levels, whilst issuing a warning.
#'
#' By default, GIGS options are `"warn"` for input handling and `"keep_warn"`
#' for `"handle_unused_levels"`
#' for `"handle_unused_levels"`.
#' @returns A single-length character vector. For `gigs_option_get()`, the
#' current value of `option`; for `gigs_option_get()`, the new value of
#' `option`; for `gigs_input_options_set()`, `new_value`. If `silent = FALSE`
Expand Down
7 changes: 5 additions & 2 deletions man/gigs_options.Rd

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

0 comments on commit 0241631

Please sign in to comment.