NYPD Arrest Data (Year to Date)

Usage

morie_datasets_nyc_nypd_arrests_ytd(
  year = NULL,
  max_features = NULL,
  offline = TRUE,
  resource_id = NULL,
  paginate = FALSE,
  page_size = 1000L,
  max_pages = 200L,
  mode = c("soda2", "soda3"),
  app_token = NULL
)

Arguments

year: Optional year filter (server-side SoQL).
max_features: Optional row cap. When paginate = TRUE this is the total cap across walked pages.
offline: If TRUE (default), read the included fixture.
resource_id: Optional Socrata resource id override.
paginate: Logical; if TRUE and offline = FALSE, walk SODA2 $offset in page_size chunks until exhausted or max_features is reached. Default FALSE (single 1,000-row request, matching the historical pre-3OO behaviour).
page_size: Per-page row count when paginating (default 1,000, the unauthenticated SODA2 ceiling).
max_pages: Safety net on paginated walks (default 200 -> up to 200,000 rows without an app_token).
mode: One of "soda2" (default JSON resource endpoint) or "soda3" (SoQL query endpoint). 3AAA dual-mode dispatch.
app_token: Optional Socrata API app token for higher rate limits; passed as the X-App-Token header.

Value

A data.frame.

Examples

df <- morie_datasets_nyc_nypd_arrests_ytd(offline = TRUE)
head(df[, c("arrest_key", "arrest_date", "ofns_desc")])
#>          arrest_key             arrest_date                      ofns_desc
#> 1 NYPD-YA-SYNTH-001 2025-01-11T00:00:00.000                        ROBBERY
#> 2 NYPD-YA-SYNTH-002 2025-02-12T00:00:00.000   ASSAULT 3 & RELATED OFFENSES
#> 3 NYPD-YA-SYNTH-003 2025-03-13T00:00:00.000 CRIMINAL MISCHIEF & RELATED OF
#> 4 NYPD-YA-SYNTH-004 2025-04-14T00:00:00.000                DANGEROUS DRUGS
#> 5 NYPD-YA-SYNTH-005 2025-05-15T00:00:00.000                  PETIT LARCENY