diagnose.revision_summary: Diagnose Method for Revision Summary

View source: R/revisions.R

diagnose.revision_summaryR Documentation

Diagnose Method for Revision Summary

Description

Provides a quick diagnostic summary of revision quality with color-coded pass/fail indicators for key metrics.

Usage

## S3 method for class 'revision_summary'
diagnose(object, alpha = 0.05, ...)

Arguments

object

An object of class revision_summary.

alpha

Significance level for hypothesis tests. Default is 0.05.

...

Additional arguments (not used).

Value

A tibble with diagnostic results.

See Also

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

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)

# Diagnose revision quality
diagnose(results)

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