Skip to contents

Read outcome records from the archive

Source: R/ingest-crime.R
lamp_read_outcomes.Rd

Reads the selected outcomes files into one table with a fixed schema, classifies outcomes with lamp_outcome_types(), detects the LSOA vintage of every file, and attaches a panel contract. An outcomes file for a month lists the outcomes recorded in that month, whose crimes may date from earlier months, and a crime can have several outcomes.

Usage

lamp_read_outcomes(
  dir = lamp_cache_dir(),
  versions = NULL,
  months = NULL,
  forces = NULL,
  fetch = FALSE
)

Arguments

dir

A cache directory (see lamp_cache_dir()) or a lamp_snapshot from lamp_archive_snapshot().

versions

A lamp_selection from lamp_select_version(); by default the newest archive version of each file is used.

months, forces

Optional filters, as in lamp_archive_download().

fetch

Fetch selected files that are listed in the snapshot but not held locally (needs network access). With the default FALSE only the files held locally are read, with a message saying how many were skipped, so a reader never starts a large download on its own.

Value

A tibble of class lamp_records with columns crime_id, month, reported_by, falls_within, force_id, longitude, latitude, location, lsoa_code, lsoa_name, lsoa_vintage, outcome_type (factor), outcome_type_raw, outcome_group (factor with the six groups of lamp_outcome_types()), archive and file, plus a contract.

See also

Other ingest: lamp_archive_download(), lamp_archive_index(), lamp_archive_register(), lamp_archive_snapshot(), lamp_list_versions(), lamp_lsoa_vintage(), lamp_read_crime(), lamp_read_stop_counts(), lamp_s60_legislation(), lamp_select_version(), lamp_version_diff()

Examples

cache <- tempfile("streetlamp-cache-")
zip <- system.file("extdata", "archive", "2026-07.zip", package = "streetlamp")
lamp_archive_register(zip, dir = cache)
#> Registered archive "2026-07" from
#> /home/runner/work/_temp/Library/streetlamp/extdata/archive/2026-07.zip.
outcomes <- lamp_read_outcomes(cache, forces = "dyfed-powys", months = "2026-07")
table(outcomes$outcome_group)
#> 
#>    charged_or_summonsed            out_of_court              no_suspect 
#>                      79                      31                     212 
#> evidential_difficulties                   other                 unknown 
#>                     527                      47                       0