clean help index page

Author: earowang

R/as-tsibble.R

@@ -139,7 +139,7 @@ as_tsibble.tbl_df <- function(x, key = NULL, index, regular = TRUE,
   )
 }
 
-#' @rdname as-tsibble
+#' @keywords internal
 #' @export
 as_tsibble.data.frame <- as_tsibble.tbl_df
 
@@ -486,7 +486,6 @@ format.tbl_ts <- function(x, ..., n = NULL, width = NULL, n_extra = NULL) {
 #'
 #' @param x A `tbl_ts`.
 #' @param ... Ignored.
-#' @inheritParams base::as.data.frame
 #'
 #' @rdname as-tibble
 #' @export
@@ -505,7 +504,7 @@ as_tibble.grouped_df <- function(x, ...) {
   x
 }
 
-#' @rdname as-tibble
+#' @keywords internal
 #' @export
 as.data.frame.tbl_ts <- function(x, row.names = NULL, optional = FALSE, ...) {
   new_data_frame(vec_data(x), n = nrow(x))

R/deprec-slide.R

@@ -74,6 +74,7 @@ bad_step_function <- function(.step) {
 #' If `.x` is a list of data frames, row binding is carried out.
 #'
 #' @return if `.fill != NULL`, it always returns the same length as input.
+#' @keywords internal
 #' @rdname slide
 #' @export
 #' @family sliding window functions
@@ -166,6 +167,7 @@ slide_dfc <- function(.x, .f, ..., .size = 1, .step = 1, .fill = NA,
 #' @param .x,.y Objects to slide over simultaneously.
 #' @inheritParams slide
 #'
+#' @keywords internal
 #' @rdname slide2
 #' @export
 #' @family sliding window functions
@@ -356,6 +358,7 @@ pslide_dfc <- function(.l, .f, ..., .size = 1, .step = 1, .fill = NA,
 #' @param .bind If `.x` is a list or data frame, the input will be flattened
 #' to a list of data frames.
 #' @inheritParams slide
+#' @keywords internal
 #' @rdname slider
 #' @seealso [partial_slider], [partial_pslider] for partial sliding
 #' @export
@@ -404,6 +407,7 @@ pslider <- function(..., .size = 1, .step = 1, .bind = FALSE) {
 #' Partially splits the input to a list according to the rolling window size.
 #'
 #' @inheritParams slide
+#' @keywords internal
 #' @rdname partial-slider
 #' @export
 #' @examples
@@ -448,8 +452,7 @@ partial_pslider <- function(..., .size = 1, .step = 1, .fill = NA,
 #' They all return a tsibble including a new column `.id` as part of the key. The
 #' output dimension will increase considerably with `slide_tsibble()` and
 #' `stretch_tsibble()`, which is likely to run out of memory when the data is
-#' large. Alternatively, you could construct cross validation using `pslide()`
-#' and `pstretch()` to avoid the memory issue.
+#' large.
 #' @family rolling tsibble
 #' @export
 #' @examples
@@ -642,6 +645,7 @@ slider_msg <- function() {
 #' @details
 #' It requires the package **furrr** to be installed. Please refer to [furrr](https://davisvaughan.github.io/furrr/) for performance and detailed usage.
 #' @evalRd {suffix <- c("lgl", "chr", "int", "dbl", "dfr", "dfc"); c(paste0('\\alias{future_', c("slide", "slide2", "pslide"), '}'), paste0('\\alias{future_slide_', suffix, '}'), paste0('\\alias{future_slide2_', suffix, '}'), paste0('\\alias{future_pslide_', suffix, '}'))}
+#' @keywords internal
 #' @name future_slide()
 #' @rdname future-slide
 #' @exportPattern ^future_

R/deprec-stretch.R

@@ -21,6 +21,7 @@ nrow2 <- function(.x) {
 #' @param .step A positive integer for incremental step.
 #'
 #' @return if `.fill != NULL`, it always returns the same length as input.
+#' @keywords internal
 #' @rdname stretch
 #' @export
 #' @family stretching window functions
@@ -91,6 +92,7 @@ stretch_dfc <- function(.x, .f, ..., .step = 1, .init = 1, .fill = NA,
 #' @inheritParams slide2
 #' @inheritParams stretch
 #'
+#' @keywords internal
 #' @rdname stretch2
 #' @export
 #' @family stretching window functions
@@ -218,6 +220,7 @@ pstretch_dfc <- function(.l, .f, ..., .step = 1, .init = 1, .fill = NA,
 #' @param .x An objects to be split.
 #' @param ... Multiple objects to be split in parallel.
 #' @inheritParams stretch
+#' @keywords internal
 #' @rdname stretcher
 #' @export
 #' @examples
@@ -338,6 +341,7 @@ incr <- function(.init, .step) {
 #' future specific options to use with the workers.
 #'
 #' @evalRd {suffix <- c("lgl", "chr", "int", "dbl", "dfr", "dfc"); c(paste0('\\alias{future_', c("stretch", "stretch2", "pstretch"), '}'), paste0('\\alias{future_stretch_', suffix, '}'), paste0('\\alias{future_stretch2_', suffix, '}'), paste0('\\alias{future_pstretch_', suffix, '}'))}
+#' @keywords internal
 #' @name future_stretch()
 #' @rdname future-stretch
 #' @exportPattern ^future_

R/deprec-tile.R

@@ -13,6 +13,7 @@
 #'
 #' @inheritParams slide
 #'
+#' @keywords internal
 #' @rdname tile
 #' @export
 #' @family tiling window functions
@@ -71,6 +72,7 @@ tile_dfc <- function(.x, .f, ..., .size = 1, .bind = FALSE) {
 #' * `tile2_dfr()` `tile2_dfc()` return data frames using row-binding & column-binding.
 #'
 #' @inheritParams slide2
+#' @keywords internal
 #' @rdname tile2
 #' @export
 #' @family tiling window functions
@@ -150,6 +152,7 @@ ptile_dfc <- function(.l, .f, ..., .size = 1, .bind = FALSE) {
 #' Splits the input to a list according to the tiling window size.
 #'
 #' @inheritParams slider
+#' @keywords internal
 #' @rdname tiler
 #' @export
 #' @examples
@@ -227,6 +230,7 @@ tile_tsibble <- function(.x, .size = 1, .id = ".id") {
 #' future specific options to use with the workers.
 #'
 #' @evalRd {suffix <- c("lgl", "chr", "int", "dbl", "dfr", "dfc"); c(paste0('\\alias{future_', c("tile", "tile2", "ptile"), '}'), paste0('\\alias{future_tile_', suffix, '}'), paste0('\\alias{future_tile2_', suffix, '}'), paste0('\\alias{future_ptile_', suffix, '}'))}
+#' @keywords internal
 #' @name future_tile()
 #' @rdname future-tile
 #' @exportPattern ^future_

R/dplyr-verbs.R

@@ -29,12 +29,34 @@
 #' Joining with other data sources triggers the check on the validity of the
 #' resulting tsibble.
 #'
-#' @param .data,data A `tbl_ts`.
-#' @param ... Same arguments accepted as its tidyverse generic.
-#' @inheritParams dplyr::filter
-#' @param .groups See [dplyr::summarise()]
-#'
+#' @usage NULL
 #' @name tsibble-tidyverse
+#' @examples
+#' library(dplyr, warn.conflicts = FALSE)
+#' # Sum over sensors
+#' pedestrian %>%
+#'   index_by() %>%
+#'   summarise(Total = sum(Count))
+#' # shortcut
+#' pedestrian %>%
+#'   summarise(Total = sum(Count))
+#' # Back to tibble
+#' pedestrian %>%
+#'   as_tibble() %>%
+#'   summarise(Total = sum(Count))
+#'
+#' library(tidyr)
+#' # reshaping examples from tidyr
+#' stocks <- tsibble(
+#'   time = as.Date("2009-01-01") + 0:9,
+#'   X = rnorm(10, 0, 1),
+#'   Y = rnorm(10, 0, 2),
+#'   Z = rnorm(10, 0, 4)
+#' )
+#' (stocksm <- stocks %>% 
+#'   pivot_longer(-time, names_to = "stock", values_to = "price"))
+#' stocksm %>% 
+#'   pivot_wider(names_from = stock, values_from = price)
 NULL
 
 #' @export
@@ -57,7 +79,6 @@ select.tbl_ts <- function(.data, ...) {
 #' @export
 select.grouped_ts <- select.tbl_ts
 
-#' @rdname tsibble-tidyverse
 #' @export
 transmute.tbl_ts <- function(.data, ...) {
   bind_tsibble(NextMethod(), .data, position = "before")
@@ -66,20 +87,6 @@ transmute.tbl_ts <- function(.data, ...) {
 #' @export
 transmute.grouped_ts <- transmute.tbl_ts
 
-#' @rdname tsibble-tidyverse
-#' @examples
-#' library(dplyr, warn.conflicts = FALSE)
-#' # Sum over sensors
-#' pedestrian %>%
-#'   index_by() %>%
-#'   summarise(Total = sum(Count))
-#' # shortcut
-#' pedestrian %>%
-#'   summarise(Total = sum(Count))
-#' # Back to tibble
-#' pedestrian %>%
-#'   as_tibble() %>%
-#'   summarise(Total = sum(Count))
 #' @export
 summarise.tbl_ts <- function(.data, ..., .groups = NULL) {
   # Unlike summarise.grouped_df(), summarise.tbl_ts() doesn't compute values for

R/scales.R

@@ -6,6 +6,7 @@
 #' @param ... Arguments passed to [`ggplot2::scale_x_date()`].
 #'
 #' @return A ggproto object inheriting from `Scale`
+#' @keywords internal
 #'
 #' @name tsibble-scales
 NULL
@@ -129,6 +130,7 @@ scale_colour_yearmonth <- function(...) {
 #' @export
 scale_color_yearmonth <- scale_colour_yearmonth
 
+#' @keywords internal
 #' @rdname tsibble-scales
 #' @export
 scale_alpha_yearmonth <- function(...) {

R/tidyr-verbs.R

@@ -1,20 +1,5 @@
 globalVariables(c("name"))
 
-#' @rdname tsibble-tidyverse
-#' @usage NULL
-#' @examples
-#' library(tidyr)
-#' # reshaping examples from tidyr
-#' stocks <- tsibble(
-#'   time = as.Date("2009-01-01") + 0:9,
-#'   X = rnorm(10, 0, 1),
-#'   Y = rnorm(10, 0, 2),
-#'   Z = rnorm(10, 0, 4)
-#' )
-#' (stocksm <- stocks %>% 
-#'     pivot_longer(-time, names_to = "stock", values_to = "price"))
-#' stocksm %>% 
-#'   pivot_wider(names_from = stock, values_from = price)
 pivot_longer.tbl_ts <- function(data, cols, names_to = "name", ...) {
   if (!has_length(names_to)) {
     abort("`pivot_longer(<tsibble>)` can't accept zero-length `names_to`.")

R/ts2tsibble.R

@@ -99,8 +99,7 @@ as_tsibble.msts <- function(x, ..., tz = "UTC", pivot_longer = TRUE) {
   }
 }
 
-#' @rdname as-tsibble
-#' @usage NULL
+#' @keywords internal
 #' @export
 as_tsibble.hts <- function(x, ..., tz = "UTC") {
   full_labs <- extract_labels(x)

R/yearweek.R

@@ -309,7 +309,6 @@ is_53weeks <- function(year) {
   p_year(year) == 4 | p_year(pre_year) == 3
 }
 
-#' @rdname year-week
 #' @export
 year.yearweek <- function(x) {
   x <- as_date(x)