manureshed (version 0.1.3)

summarize_results: Print Summary of Analysis Results

Description

Print formatted summary of manureshed analysis results to the console. The summary includes analysis configuration parameters (scale, year, nutrients, WWTP inclusion), spatial coverage statistics, agricultural nutrient classifications with counts and percentages, WWTP integration metrics (if applicable), integrated classifications (if available), output file information, and processing time.

Usage

summarize_results(results, detailed = FALSE)

Value

Invisibly returns the input results list unchanged. The function is called primarily for its side effect of printing a formatted summary to the console. The invisible return allows for piping operations while displaying the summary.

Arguments

results

List. Analysis results from run_builtin_analysis or run_state_analysis. Must contain at minimum:

• parameters: List with scale, year, nutrients, include_wwtp

• agricultural: sf data frame with classification columns

Optional components:

• wwtp: WWTP analysis results

• integrated: Integrated classification results

• created_files or saved_files: Output file paths

detailed

Logical. If TRUE, includes additional breakdown of integrated classifications showing combined agricultural-WWTP nutrient classes. If FALSE (default), shows only agricultural classifications and basic WWTP statistics.

Details

The summary output is organized into sections:

Analysis Configuration

Scale, year, nutrients analyzed, WWTP inclusion, state (if applicable)

Spatial Coverage

Total number of spatial units analyzed

Agricultural Classifications

Nitrogen and phosphorus classification counts and percentages

WWTP Integration

Number of facilities and total loads by nutrient (if applicable)

Integrated Classifications

Combined agricultural-WWTP classes (if detailed = TRUE)

Output Files

Number and types of created files (if saved)

Processing Time

Analysis duration in minutes (if available)

Classification names are cleaned for display (underscores replaced with spaces, line breaks removed). Percentages are rounded to one decimal place. All console output uses message and can be suppressed with suppressMessages.

See Also

run_builtin_analysis for generating analysis results, quick_check for quick validation, compare_analyses for comparing two result sets

Examples

# \donttest{
# Basic summary
results <- run_builtin_analysis(scale = "county", year = 2016)
summarize_results(results)

# Detailed summary with integrated classifications
results <- run_builtin_analysis(
  scale = "huc8",
  year = 2012,
  include_wwtp = TRUE
)
summarize_results(results, detailed = TRUE)
# }
if (FALSE) {
  # This requires magrittr - never auto-run
  library(magrittr)
  results <- run_builtin_analysis(scale = "huc2", year = 2015) %>%
    summarize_results() %>%
    export_for_gis(output_dir = tempdir())
}