r-lib / generics
Showing 1 of 5 files from the diff.
Other files ignored by Codecov
NEWS.md has changed.
NAMESPACE has changed.
DESCRIPTION has changed.

@@ -0,0 +1,28 @@
Loading
1 +
#' Determine arguments tagged for tuning
2 +
#'
3 +
#' `tune_args()` takes an object such as a model specification or a recipe and
4 +
#' returns a tibble of information on all possible tunable arguments and
5 +
#' whether or not they are actually tunable.
6 +
#'
7 +
#' @param object A `model_spec`, `recipe`, `workflow`, or other object.
8 +
#' @param ... Other arguments passed to methods.
9 +
#'
10 +
#' @details
11 +
#' The `source` column is determined differently for a
12 +
#' `model_spec` or a `recipe` (with additional detail on the type).
13 +
#'
14 +
#' The `id` field has any identifier that was passed from [tune::tune()] (e.g.
15 +
#' `tune("some note")`). If no additional detail was used in that function,
16 +
#' the `id` field reverts to the name of the parameters.
17 +
#'
18 +
#' @return A tibble with columns for the parameter name (`name`), whether it
19 +
#' contains _any_ tunable value (`tune`), the `id` for the parameter (`id`),
20 +
#' and the information on where the parameter was located (`source`).
21 +
#'
22 +
#' @section Methods:
23 +
#' \Sexpr[stage=render,results=rd]{generics:::methods_rd("tune_args")}
24 +
#'
25 +
#' @export
26 +
tune_args <- function(object, ...) {
27 +
  UseMethod("tune_args")
28 +
}
Files Coverage
R 60.63%
Project Totals (32 files) 60.63%
1
comment: false
2

3
coverage:
4
  status:
5
    project:
6
      default:
7
        target: auto
8
        threshold: 1%
9
        informational: true
10
    patch:
11
      default:
12
        target: auto
13
        threshold: 1%
14
        informational: true
Sunburst
The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.
Icicle
The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.
Grid
Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.
Loading