Skip to contents

Returns a one-line description of the list that names its class and the site_id of its site, such as "<cacs_site_plot_pipeline: 4 widgets for site AL_BHM_01>", for use in text (for example, sprintf("Maps: %s", format(x))).

Usage

# S3 method for class 'cacs_site_plot_pipeline'
format(x, ...)

Arguments

x

A list of class "cacs_site_plot_pipeline", as returned by cacs_plot_site_pipeline().

...

Not used.

Value

A string.

Examples

if (requireNamespace("leaflet", quietly = TRUE)) {
  fx <- readRDS(system.file("extdata", "visual_walkthrough_fixture.rds",
                            package = "catchmentACS"))
  maps <- cacs_plot_site_pipeline(
    site_id = "AL_BHM_01", iso_sf = fx$iso_sf, tract_sf = fx$tract_sf,
    acs_sf = fx$acs_sf, run_result = fx$run_result, sites_df = fx$sites_df
  )
  sprintf("Maps: %s", format(maps))
}
#> [1] "Maps: <cacs_site_plot_pipeline: 4 widgets for site AL_BHM_01>"