Summarise creel survey estimates as a formatted table

summary.creel_estimates() converts a creel_estimates object into a creel_summary table with human-readable column names, suitable for display or export.

Usage

# S3 method for class 'creel_estimates'
summary(object, digits = 4L, ...)

Arguments

object

A creel_estimates object returned by estimate_effort(), estimate_catch_rate(), estimate_harvest_rate(), estimate_total_catch(), or estimate_total_harvest().

digits

Integer number of significant digits for numeric columns (default: 4).

...

Additional arguments (currently ignored).

Value

A creel_summary S3 object (a list) with components:

table

A data.frame with columns: any grouping variables, Estimate, SE, CI Lower, CI Upper, N.

method

Character string — the estimation method.

variance_method

Character string — the variance method.

conf_level

Numeric confidence level (e.g. 0.95).

See also

estimate_effort(), estimate_catch_rate(), estimate_harvest_rate()

Other "Reporting & Diagnostics": adjust_nonresponse(), check_completeness(), compare_variance(), flag_outliers(), season_summary(), standardize_species(), summarize_by_angler_type(), summarize_by_day_type(), summarize_by_method(), summarize_by_species_sought(), summarize_by_trip_length(), summarize_cws_rates(), summarize_hws_rates(), summarize_length_freq(), summarize_refusals(), summarize_successful_parties(), summarize_trips(), validate_creel_data(), validate_design(), validate_incomplete_trips(), validation_report(), write_estimates()

Examples

if (FALSE) { # \dontrun{
est <- estimate_effort(design)
summary(est)
as.data.frame(summary(est))
} # }