add examples

Author: marcburri

R/revisions.R

@@ -566,6 +566,19 @@ get_first_efficient_release <- function(
 #' @return The function returns the input \code{x} invisibly.
 #' @method print lst_efficient
 #' @family revision analysis
+#' @examples
+#' df <- get_nth_release(
+#'   tsbox::ts_pc(dplyr::filter(reviser::gdp, id == "US")),
+#'   n = 0:3
+#' )
+#'
+#' final_release <- get_nth_release(
+#'   tsbox::ts_pc(dplyr::filter(reviser::gdp, id == "US")),
+#'   n = 10
+#' )
+#'
+#' result <- get_first_efficient_release(df, final_release, significance = 0.05)
+#' print(result)
 #' @export
 print.lst_efficient <- function(x, ...) {
   summary.lst_efficient(x, ...)
@@ -1132,6 +1145,36 @@ get_revision_analysis <- function(
 #' @return The function returns the input \code{x} invisibly.
 #' @method print revision_summary
 #' @family revision analysis
+#' @examples
+#' df <- dplyr::select(
+#'   get_nth_release(
+#'     na.omit(
+#'       tsbox::ts_pc(
+#'         dplyr::filter(reviser::gdp, id == "US")
+#'       )
+#'     ),
+#'     n = 0:3
+#'   ),
+#'   -"pub_date"
+#' )
+#'
+#' final_release <- dplyr::select(
+#'   get_nth_release(
+#'     na.omit(
+#'       tsbox::ts_pc(
+#'         dplyr::filter(reviser::gdp, id == "US")
+#'       )
+#'     ),
+#'     n = "latest"
+#'   ),
+#'   -"pub_date"
+#' )
+#'
+#' results <- get_revision_analysis(df, final_release, degree = 1)
+#' print(results)
+#'
+#' # Print without interpretation
+#' print(results, interpretation = FALSE)
 #' @export
 print.revision_summary <- function(x, interpretation = TRUE, digits = 3, ...) {
   cat("\n=== Revision Analysis Summary ===\n\n")

R/utils.R

@@ -706,6 +706,10 @@ make_explicit_missing <- function(
 #' @return A named character vector where names are labels and values are 
 #'   the corresponding information. The vector is used by pillar to format
 #'   the tibble header.
+#' @examples
+#' df <- dplyr::filter(reviser::gdp, id == "US")
+#' wide_data <- vintages_wide(df)
+#' pillar::tbl_sum(wide_data$US)
 #' @family helpers
 #' @export
 tbl_sum.tbl_pubdate <- function(x, ...) {
@@ -744,10 +748,13 @@ tbl_sum.tbl_pubdate <- function(x, ...) {
 #'
 #' @return The input \code{x} is returned invisibly.
 #' @method print tbl_pubdate
+#' @examples
+#' df <- dplyr::filter(reviser::gdp, id == "US")
+#' wide_data <- vintages_wide(df)
+#' print(wide_data$US)
 #' @family helpers
 #' @export
 print.tbl_pubdate <- function(x, ...) {
-  # Delegate to tibble's print method, which will call tbl_sum.tbl_pubdate
   NextMethod("print")
   invisible(x)
 }
@@ -761,6 +768,10 @@ print.tbl_pubdate <- function(x, ...) {
 #'
 #' @return A named character vector where names are labels and values are 
 #'   the corresponding information.
+#' @examples
+#' df <- dplyr::filter(reviser::gdp, id == "US")
+#' release_data <- get_nth_release(df, n = 0:3)
+#' pillar::tbl_sum(release_data)
 #' @family helpers
 #' @export
 tbl_sum.tbl_release <- function(x, ...) {
@@ -796,6 +807,10 @@ tbl_sum.tbl_release <- function(x, ...) {
 #'
 #' @return The input \code{x} is returned invisibly.
 #' @method print tbl_release
+#' @examples
+#' df <- dplyr::filter(reviser::gdp, id == "US")
+#' release_data <- get_nth_release(df, n = 0:3)
+#' print(release_data)
 #' @family helpers
 #' @export
 print.tbl_release <- function(x, ...) {
@@ -810,6 +825,10 @@ print.tbl_release <- function(x, ...) {
 #'
 #' @return The function returns a summary tibble invisibly.
 #' @method summary tbl_pubdate
+#' @examples
+#' df <- dplyr::filter(reviser::gdp, id == "US")
+#' wide_data <- vintages_wide(df)
+#' summary(wide_data$US)
 #' @family helpers
 #' @export
 summary.tbl_pubdate <- function(object, ...) {
@@ -863,6 +882,15 @@ summary.tbl_pubdate <- function(object, ...) {
 #'
 #' @return The function returns a summary tibble invisibly.
 #' @method summary tbl_release
+#' @examples
+#' df <- dplyr::filter(reviser::gdp, id == "US")
+#' # Long format
+#' release_data <- get_nth_release(df, n = 0:3)
+#' summary(release_data)
+#'
+#' # Wide format
+#' wide_release <- vintages_wide(release_data, names_from = "release")
+#' summary(wide_release$US)
 #' @family helpers
 #' @export
 summary.tbl_release <- function(object, ...) {