Skip to contents

Print Method for Summary of Harmonic Smoother Results

Source: R/harmonic_smoother.R
print.summary.harmonic_smoother.Rd

Prints the summary of harmonic smoother results in a formatted manner.

Usage

# S3 method for class 'summary.harmonic_smoother'
print(x, ...)

Arguments

x

An object of class "summary.harmonic_smoother".

...

Further arguments passed to or from other methods.

Value

Invisibly returns the input object.

See also

summary.harmonic_smoother

Examples

object <- structure(
  list(
    stable_iteration = 2L,
    iterations_recorded = 1L,
    initial_extrema = 1L,
    initial_maxima = 1L,
    initial_minima = 0L,
    final_extrema = 1L,
    final_maxima = 1L,
    final_minima = 0L,
    extrema_reduction = 0L,
    topology_diff_summary = NULL
  ),
  class = "summary.harmonic_smoother"
)
print(object)
#> Summary of Harmonic Smoother Results
#> -----------------------------------
#> Numerical convergence: unavailable (older object) 
#> Extrema stability detection: unavailable (older object)
#> Total iterations recorded: 1
#> 
#> Extrema Evolution:
#>   Initial: 1 total (1 maxima, 0 minima)
#>   Final:   1 total (1 maxima, 0 minima)
#>   Reduction: 0 extrema (0.0%)
#>