r-lib / generics
1
#' Extract components
2
#'
3
#' `components` can be used to extract elements from an object.
4
#'
5
#' For example, decomposition methods and some modelling techniques can be used
6
#' to decompose a dataset into components of interest. This function is used
7
#' to extract these components in a tidy data format.
8
#'
9
#' @param object A data separable object.
10
#' @param ... Other arguments passed to methods
11
#'
12
#' @return A dataset ([tibble::tibble()] or similar) containing components from
13
#' the object.
14
#'
15
#' @section Methods:
16
#' \Sexpr[stage=render,results=rd]{generics:::methods_rd("components")}
17
#'
18
#' @export
19
components <- function(object, ...) {
20 0
  UseMethod("components")
21
}

Read our documentation on viewing source code .

Loading