summary.revision_summary: Summary Method for Revision Summary

View source: R/revisions.R

summary.revision_summaryR Documentation

Summary Method for Revision Summary

Description

Summary Method for Revision Summary

Usage

## S3 method for class 'revision_summary'
summary(object, interpretation = TRUE, ...)

Arguments

object

An object of class revision_summary.

interpretation

Logical. If TRUE, provides interpretation of key statistics. Default is TRUE.

...

Additional arguments passed to print.

Value

The function returns the input object invisibly.

See Also

Other revision analysis: diagnose(), diagnose.revision_summary(), get_first_efficient_release(), get_revision_analysis(), print.lst_efficient(), print.revision_summary(), summary.lst_efficient()

Examples

# Example usage with revision analysis results
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"
)

# Get revision analysis results
results <- get_revision_analysis(df, final_release, degree = 5)

# Summarize revision quality
summary(results)

reviser documentation built on Sept. 14, 2026, 9:09 a.m.