Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f4ab9b6d90
|
||
|
|
9508b98676 | ||
|
|
0fbae00e27
|
||
|
|
698812a25c | ||
|
|
d74ecdd4a5 | ||
|
|
72b2cc3a26
|
||
|
|
28c500f47a
|
||
|
|
fe9238a6ef | ||
|
|
6392a74013
|
||
|
|
de2ba0cfb9 | ||
|
|
e912a926c2 | ||
|
|
785f3af16d
|
@@ -0,0 +1,43 @@
|
|||||||
|
# Mirror the canonical Gitea repo to the public GitHub mirror.
|
||||||
|
#
|
||||||
|
# Deliberately a plain `git push`, NOT Gitea's built-in push mirror. A push
|
||||||
|
# mirror force-updates the refs it owns: if anyone ever clicks Merge on a
|
||||||
|
# GitHub PR, the next sync silently overwrites main, the PR still displays
|
||||||
|
# "Merged", the commit becomes unreachable, and nothing anywhere says so.
|
||||||
|
# A non-force push is REJECTED as non-fast-forward the moment that happens,
|
||||||
|
# turning a silent data-loss trap into a red CI run in a place we already look.
|
||||||
|
#
|
||||||
|
# Do NOT add --force here, and do NOT add GitHub branch protection to the
|
||||||
|
# mirror: protection rules block the mirror's legitimate pushes too, breaking
|
||||||
|
# normal syncing to catch an abnormal case.
|
||||||
|
#
|
||||||
|
# PAT_GH is a GitHub personal access token (repo + workflow scope; workflow is
|
||||||
|
# required because this pushes .github/workflows/). It is stored as a Gitea
|
||||||
|
# Actions secret. The name cannot begin with GITHUB_ or GITEA_ -- Gitea
|
||||||
|
# reserves both prefixes for its own injected variables and rejects the secret.
|
||||||
|
name: Mirror to GitHub
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
tags: ['v*']
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
mirror:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Push main and tags to the GitHub mirror
|
||||||
|
env:
|
||||||
|
PAT_GH: ${{ secrets.PAT_GH }}
|
||||||
|
run: |
|
||||||
|
set -eu
|
||||||
|
if [ -z "${PAT_GH:-}" ]; then
|
||||||
|
echo "PAT_GH is unset -- add it under Settings > Actions > Secrets." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
git push "https://x-access-token:${PAT_GH}@github.com/civilytics/uscogdata.git" \
|
||||||
|
HEAD:refs/heads/main --tags
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
# Multi-platform R CMD check, running on the GitHub mirror.
|
||||||
|
#
|
||||||
|
# This exists because the canonical Gitea runner is Linux-only, and this
|
||||||
|
# package hard-depends on duckdb and httr2 -- both compiled, both with real
|
||||||
|
# platform variance -- while having never been checked on Windows or macOS.
|
||||||
|
# A large share of the audience is on Windows.
|
||||||
|
#
|
||||||
|
# Gitea reads .gitea/workflows and GitHub reads .github/workflows, so this
|
||||||
|
# file is inert on the canonical repo and coexists with the Gitea CI that
|
||||||
|
# remains authoritative for deploys.
|
||||||
|
#
|
||||||
|
# The suite needs NO credentials: tests/testthat/setup.R points USCOGDATA_URL
|
||||||
|
# at the bundled fixture corpus. That is exactly why inst/extdata/fixture_corpus
|
||||||
|
# must never be added to .Rbuildignore.
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
name: R-CMD-check
|
||||||
|
|
||||||
|
permissions: read-all
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
R-CMD-check:
|
||||||
|
runs-on: ${{ matrix.config.os }}
|
||||||
|
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
config:
|
||||||
|
- {os: macos-latest, r: 'release'}
|
||||||
|
- {os: windows-latest, r: 'release'}
|
||||||
|
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
|
||||||
|
- {os: ubuntu-latest, r: 'release'}
|
||||||
|
|
||||||
|
env:
|
||||||
|
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
R_KEEP_PKG_SOURCE: yes
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: r-lib/actions/setup-pandoc@v2
|
||||||
|
|
||||||
|
- uses: r-lib/actions/setup-r@v2
|
||||||
|
with:
|
||||||
|
r-version: ${{ matrix.config.r }}
|
||||||
|
http-user-agent: ${{ matrix.config.http-user-agent }}
|
||||||
|
use-public-rspm: true
|
||||||
|
|
||||||
|
- uses: r-lib/actions/setup-r-dependencies@v2
|
||||||
|
with:
|
||||||
|
extra-packages: any::rcmdcheck
|
||||||
|
needs: check
|
||||||
|
|
||||||
|
- uses: r-lib/actions/check-r-package@v2
|
||||||
|
with:
|
||||||
|
upload-snapshots: true
|
||||||
|
build_args: 'c("--no-manual")'
|
||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
Package: uscogdata
|
Package: uscogdata
|
||||||
Type: Package
|
Type: Package
|
||||||
Title: Curated Reader for the Civilytics US Census of Governments Finance Corpus
|
Title: Curated Reader for the Civilytics US Census of Governments Finance Corpus
|
||||||
Version: 0.3.0
|
Version: 0.4.0
|
||||||
Authors@R: c(
|
Authors@R: c(
|
||||||
person(c("Jared", "E."), "Knowles",
|
person(c("Jared", "E."), "Knowles",
|
||||||
email = "jared@civilytics.com",
|
email = "jared@civilytics.com",
|
||||||
|
|||||||
@@ -1,3 +1,78 @@
|
|||||||
|
# uscogdata 0.4.0
|
||||||
|
|
||||||
|
## DuckDB's resource budget is configurable
|
||||||
|
|
||||||
|
`USCOGDATA_DUCKDB_THREADS` and `USCOGDATA_DUCKDB_MEMORY_LIMIT` (with matching
|
||||||
|
`options(uscogdata.duckdb_threads = )` / `options(uscogdata.duckdb_memory_limit = )`
|
||||||
|
spellings) cap the DuckDB connection the package opens. Both follow the same
|
||||||
|
env-var > option > default precedence as `USCOGDATA_URL`.
|
||||||
|
|
||||||
|
Unset, **no pragma is issued at all** and DuckDB's own defaults apply exactly as
|
||||||
|
before -- every visible core. That is right for one interactive session on a
|
||||||
|
dedicated machine and wrong for a server: where several readers share a host, each
|
||||||
|
otherwise claims the whole machine and they contend. Capping measured ~5% on a
|
||||||
|
single-government all-years query (502 ms at 2 threads vs 475 ms uncapped on 16
|
||||||
|
cores), which is cheap enough that a server should always cap.
|
||||||
|
|
||||||
|
This replaces a workaround in which a consumer reached into the package namespace
|
||||||
|
at boot -- `getFromNamespace(".ensure_session", "uscogdata")()` followed by a manual
|
||||||
|
`SET threads` -- depending both on a private name and on the session already being
|
||||||
|
open.
|
||||||
|
|
||||||
|
## Cohorts can be named by predicate, not just by id
|
||||||
|
|
||||||
|
`cog_spending()`, `cog_revenue()` and `cog_balances()` gain optional `state`
|
||||||
|
and `type` arguments. Both default to `NULL`, so every existing call behaves
|
||||||
|
exactly as before.
|
||||||
|
|
||||||
|
Passing them expresses the cohort as a subquery against `canonical_fips_xwalk`
|
||||||
|
inside each statement, instead of round-tripping the ids through R and
|
||||||
|
rendering them back into a literal `IN` list:
|
||||||
|
|
||||||
|
```r
|
||||||
|
# before: resolve 20,106 ids in R, then embed them in every statement
|
||||||
|
ids <- cog_gov_search(NULL, state = "CA", type = "city")$canonical_govid
|
||||||
|
cog_spending(ids, years = 2022)
|
||||||
|
|
||||||
|
# now: the cohort never leaves the database
|
||||||
|
cog_spending(years = 2022, state = "CA", type = "city")
|
||||||
|
```
|
||||||
|
|
||||||
|
Measured against the production corpus, same FY2022 aggregate over the
|
||||||
|
20,106-government `type = "city"` cohort:
|
||||||
|
|
||||||
|
| cohort expressed as | time |
|
||||||
|
|---|---:|
|
||||||
|
| `IN (20,106 literals)` | 449 ms |
|
||||||
|
| join against a temp cohort table | 99 ms |
|
||||||
|
| predicate on `canonical_fips_xwalk` | **94 ms** |
|
||||||
|
| no cohort filter at all (the floor) | 88 ms |
|
||||||
|
|
||||||
|
**4.8x, within 7% of the floor.** The rendered `IN` list was 301,591
|
||||||
|
characters and was re-parsed in 5-8 separate statements per call, so the cost
|
||||||
|
was paid repeatedly; the predicate's size is constant in the cohort.
|
||||||
|
|
||||||
|
`state` and `type` use the same vocabulary and the same internal coercion as
|
||||||
|
`cog_gov_search()` -- `state` is a postal abbreviation (`"WI"`) even though the
|
||||||
|
crosswalk column holds a FIPS code (`"55"`).
|
||||||
|
|
||||||
|
Supplying `govid` **and** `state`/`type` intersects them: the governments in
|
||||||
|
`govid` that also match the predicate. Naming no cohort at all now aborts with
|
||||||
|
class `uscogdata_no_cohort` rather than R's "argument is missing" error.
|
||||||
|
|
||||||
|
When the cohort is named by predicate there is no id list to report, so
|
||||||
|
`provenance$scope$govids_found`/`govids_missing` are empty and
|
||||||
|
`provenance$scope$cohort` carries `state`, `type` and `n_governments` instead.
|
||||||
|
A `govid`-named cohort's provenance is unchanged.
|
||||||
|
|
||||||
|
## Fixes
|
||||||
|
|
||||||
|
* An unknown `state` abbreviation now aborts with "Unknown state abbreviation"
|
||||||
|
(class `uscogdata_unknown_state`) instead of base R's "subscript out of
|
||||||
|
bounds". `.state_abbrev_to_fips` is a named character vector, so `[[` on an
|
||||||
|
absent name threw before the curated message could be reached -- making that
|
||||||
|
message unreachable dead code in every verb that takes a `state`.
|
||||||
|
|
||||||
# uscogdata 0.3.0
|
# uscogdata 0.3.0
|
||||||
|
|
||||||
First public release.
|
First public release.
|
||||||
|
|||||||
+13
-7
@@ -18,7 +18,9 @@
|
|||||||
#' comparable to a GAAP fund balance from an ACFR.
|
#' comparable to a GAAP fund balance from an ACFR.
|
||||||
#'
|
#'
|
||||||
#' @param govid Canonical govid(s): a character vector, or a data frame with a
|
#' @param govid Canonical govid(s): a character vector, or a data frame with a
|
||||||
#' `canonical_govid` column (e.g. from [cog_gov_search()]).
|
#' `canonical_govid` column (e.g. from [cog_gov_search()]). `NULL` to name
|
||||||
|
#' the cohort by `state`/`type` instead.
|
||||||
|
#' @inheritParams cog_spending
|
||||||
#' @param years Integer vector of fiscal years.
|
#' @param years Integer vector of fiscal years.
|
||||||
#' @param category Optional character vector of categories to keep. One of
|
#' @param category Optional character vector of categories to keep. One of
|
||||||
#' `"Fund Balances"`, `"Insurance Trust Balances"`,
|
#' `"Fund Balances"`, `"Insurance Trust Balances"`,
|
||||||
@@ -63,15 +65,16 @@
|
|||||||
#' requested years). `expenditure_concept`/`revenue_concept` are `NA` --
|
#' requested years). `expenditure_concept`/`revenue_concept` are `NA` --
|
||||||
#' holdings are a stock, not a flow, so neither concept vocabulary applies.
|
#' holdings are a stock, not a flow, so neither concept vocabulary applies.
|
||||||
#' @export
|
#' @export
|
||||||
cog_balances <- function(govid, years, category = NULL,
|
cog_balances <- function(govid = NULL, years, category = NULL,
|
||||||
per_capita = FALSE, adjust_to_year = NULL,
|
per_capita = FALSE, adjust_to_year = NULL,
|
||||||
basis = c("harmonized", "raw"), recipe = NULL) {
|
basis = c("harmonized", "raw"), recipe = NULL,
|
||||||
|
state = NULL, type = NULL) {
|
||||||
call <- match.call()
|
call <- match.call()
|
||||||
basis <- match.arg(basis, c("harmonized", "raw"))
|
basis <- match.arg(basis, c("harmonized", "raw"))
|
||||||
# Coerce FIRST, validate second: .validate_verb_inputs() asserts
|
# Coerce FIRST, validate second: .validate_verb_inputs() asserts
|
||||||
# is.character(govid), and a data-frame govid (cog_gov_search() output) has
|
# is.character(govid), and a data-frame govid (cog_gov_search() output) has
|
||||||
# not been unwrapped yet at this point.
|
# not been unwrapped yet at this point.
|
||||||
govid <- .coerce_govid_input(govid)
|
govid <- if (is.null(govid)) NULL else .coerce_govid_input(govid)
|
||||||
# The money verbs' validator, reused rather than re-implemented (R/spending.R).
|
# The money verbs' validator, reused rather than re-implemented (R/spending.R).
|
||||||
# It covers the exact superset cog_balances() needs -- including the
|
# It covers the exact superset cog_balances() needs -- including the
|
||||||
# recipe/category mutual-exclusivity guard -- so a second local copy would
|
# recipe/category mutual-exclusivity guard -- so a second local copy would
|
||||||
@@ -91,6 +94,8 @@ cog_balances <- function(govid, years, category = NULL,
|
|||||||
years <- as.integer(years)
|
years <- as.integer(years)
|
||||||
if (!is.null(adjust_to_year)) adjust_to_year <- as.integer(adjust_to_year)
|
if (!is.null(adjust_to_year)) adjust_to_year <- as.integer(adjust_to_year)
|
||||||
|
|
||||||
|
cohort <- .make_cohort(govid, state, type)
|
||||||
|
|
||||||
con <- .ensure_session()
|
con <- .ensure_session()
|
||||||
.require_balance_support(con)
|
.require_balance_support(con)
|
||||||
scope <- .check_govids_in_scope(govid)
|
scope <- .check_govids_in_scope(govid)
|
||||||
@@ -109,7 +114,7 @@ cog_balances <- function(govid, years, category = NULL,
|
|||||||
.validate_recipe_id(con, recipe)
|
.validate_recipe_id(con, recipe)
|
||||||
comps <- .recipe_components(con, recipe)
|
comps <- .recipe_components(con, recipe)
|
||||||
recipe_label <- comps$label[[1]]
|
recipe_label <- comps$label[[1]]
|
||||||
result <- .run_recipe(con, recipe, govid, years)
|
result <- .run_recipe(con, recipe, cohort, years)
|
||||||
sql <- attr(result, "sql_query")
|
sql <- attr(result, "sql_query")
|
||||||
result <- .shape_recipe_result(result, "balance_subtype", recipe_label)
|
result <- .shape_recipe_result(result, "balance_subtype", recipe_label)
|
||||||
recipe_block <- list(
|
recipe_block <- list(
|
||||||
@@ -119,7 +124,7 @@ cog_balances <- function(govid, years, category = NULL,
|
|||||||
category_for_prov <- recipe_label
|
category_for_prov <- recipe_label
|
||||||
} else {
|
} else {
|
||||||
sql <- .build_verb_sql("balance_annotated", "balance_subtype",
|
sql <- .build_verb_sql("balance_annotated", "balance_subtype",
|
||||||
govid, years, category,
|
cohort, years, category,
|
||||||
ig_view = NULL, subtype_scope = NULL)
|
ig_view = NULL, subtype_scope = NULL)
|
||||||
result <- tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
result <- tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
||||||
}
|
}
|
||||||
@@ -127,7 +132,7 @@ cog_balances <- function(govid, years, category = NULL,
|
|||||||
# Order matters (matches .verb_spendrev()): per-capita first, so
|
# Order matters (matches .verb_spendrev()): per-capita first, so
|
||||||
# .attach_real_dollars() deflates the nominal per-capita column into
|
# .attach_real_dollars() deflates the nominal per-capita column into
|
||||||
# amt_per_capita_real rather than needing amt_per_capita_nominal recomputed.
|
# amt_per_capita_real rather than needing amt_per_capita_nominal recomputed.
|
||||||
if (isTRUE(per_capita)) result <- .attach_per_capita(result, con, govid)
|
if (isTRUE(per_capita)) result <- .attach_per_capita(result, con)
|
||||||
if (!is.null(adjust_to_year)) {
|
if (!is.null(adjust_to_year)) {
|
||||||
result <- .attach_real_dollars(result, adjust_to_year, per_capita)
|
result <- .attach_real_dollars(result, adjust_to_year, per_capita)
|
||||||
}
|
}
|
||||||
@@ -145,6 +150,7 @@ cog_balances <- function(govid, years, category = NULL,
|
|||||||
)
|
)
|
||||||
prov$scope$govids_found <- scope$found
|
prov$scope$govids_found <- scope$found
|
||||||
prov$scope$govids_missing <- scope$missing
|
prov$scope$govids_missing <- scope$missing
|
||||||
|
prov$scope$cohort <- .cohort_provenance(con, cohort)
|
||||||
|
|
||||||
prov$balance_caveats <- .balance_caveats(
|
prov$balance_caveats <- .balance_caveats(
|
||||||
con, prov$codes_summed$observed, years
|
con, prov$codes_summed$observed, years
|
||||||
|
|||||||
@@ -54,7 +54,7 @@
|
|||||||
#' expenditure_concept = "total": ig_long_harmonized COALESCEs rather than
|
#' expenditure_concept = "total": ig_long_harmonized COALESCEs rather than
|
||||||
#' drops NULL-harmonized rows, so harmonization never excludes an IG row.
|
#' drops NULL-harmonized rows, so harmonization never excludes an IG row.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.build_harmonization_block <- function(con, govid, years, resolved,
|
.build_harmonization_block <- function(con, cohort, years, resolved,
|
||||||
subtype_col, subtype_scope) {
|
subtype_col, subtype_scope) {
|
||||||
if (!identical(resolved$basis, "harmonized")) {
|
if (!identical(resolved$basis, "harmonized")) {
|
||||||
return(list(
|
return(list(
|
||||||
@@ -68,12 +68,12 @@
|
|||||||
sql <- sprintf(
|
sql <- sprintf(
|
||||||
"SELECT COUNT(*) AS n, COALESCE(SUM(amt), 0) * 1000.0 AS amt
|
"SELECT COUNT(*) AS n, COALESCE(SUM(amt), 0) * 1000.0 AS amt
|
||||||
FROM long
|
FROM long
|
||||||
WHERE canonical_govid IN (%s) AND year IN (%s)
|
WHERE %s AND year IN (%s)
|
||||||
AND NOT is_aggregate AND harmonized_code IS NULL
|
AND NOT is_aggregate AND harmonized_code IS NULL
|
||||||
AND item_code IN (
|
AND item_code IN (
|
||||||
SELECT item_code FROM summary_categories WHERE %s IN (%s)
|
SELECT item_code FROM summary_categories WHERE %s IN (%s)
|
||||||
)",
|
)",
|
||||||
.sql_lit_chr(govid), paste(as.integer(years), collapse = ","),
|
.cohort_sql(cohort), paste(as.integer(years), collapse = ","),
|
||||||
subtype_col, .sql_lit_chr(subtype_scope)
|
subtype_col, .sql_lit_chr(subtype_scope)
|
||||||
)
|
)
|
||||||
na <- DBI::dbGetQuery(con, sql)
|
na <- DBI::dbGetQuery(con, sql)
|
||||||
|
|||||||
+127
@@ -0,0 +1,127 @@
|
|||||||
|
# How a verb names the set of governments it queries.
|
||||||
|
#
|
||||||
|
# Historically there was one way: a `govid` character vector, rendered by
|
||||||
|
# .sql_lit_chr() into a quoted IN list. That is fine for a handful of
|
||||||
|
# governments and pathological for a fleet. Measured against the production
|
||||||
|
# corpus, the same FY2022 aggregate over the 20,106-government `type = "city"`
|
||||||
|
# cohort:
|
||||||
|
#
|
||||||
|
# cohort expressed as time
|
||||||
|
# IN (20,106 literals) 449 ms
|
||||||
|
# join against a temp cohort table 99 ms
|
||||||
|
# predicate on canonical_fips_xwalk 94 ms
|
||||||
|
# no cohort filter at all (the floor) 88 ms
|
||||||
|
#
|
||||||
|
# 4.8x, and within 7% of the no-filter floor. The rendered IN list is 301,591
|
||||||
|
# characters and .verb_spendrev() embeds it in 5-8 separate statements per
|
||||||
|
# call, so the parse-and-plan cost is paid over and over (uscogdata#58).
|
||||||
|
#
|
||||||
|
# A cohort therefore has two independent halves, and a query can carry either
|
||||||
|
# or both:
|
||||||
|
#
|
||||||
|
# ids an explicit canonical_govid vector -> literal IN list
|
||||||
|
# predicate state/type over canonical_fips_xwalk -> IN (SELECT ...)
|
||||||
|
#
|
||||||
|
# Both together is an INTERSECTION -- "these ids, narrowed to that state/type"
|
||||||
|
# -- never a precedence rule where one silently wins.
|
||||||
|
|
||||||
|
#' Build the internal cohort object shared by every query verb.
|
||||||
|
#'
|
||||||
|
#' `state` and `type` are coerced with the SAME helpers `cog_gov_search()`
|
||||||
|
#' uses. That is load-bearing, not tidiness: the public argument is a postal
|
||||||
|
#' abbreviation (`"WI"`) while `canonical_fips_xwalk.fips_state` holds a FIPS
|
||||||
|
#' code (`"55"`), and `type` is a label (`"city"`) against an integer
|
||||||
|
#' `govs_type`. A predicate written against the raw parameter matches nothing
|
||||||
|
#' and returns an empty result indistinguishable from "this government
|
||||||
|
#' reported nothing" -- cog-api hit exactly that trap optimizing this path.
|
||||||
|
#' One definition of the translation, not two.
|
||||||
|
#'
|
||||||
|
#' @param govid Already-coerced character vector of canonical_govids, or NULL.
|
||||||
|
#' @param state Postal abbreviation or FIPS code, or NULL.
|
||||||
|
#' @param type Type label or integer code, or NULL.
|
||||||
|
#' @noRd
|
||||||
|
.make_cohort <- function(govid = NULL, state = NULL, type = NULL) {
|
||||||
|
if (is.null(govid) && is.null(state) && is.null(type)) {
|
||||||
|
cli::cli_abort(c(
|
||||||
|
"A cohort must be named.",
|
||||||
|
"*" = "Pass {.arg govid} for specific governments, or {.arg state}/{.arg type} for every government matching a predicate.",
|
||||||
|
"i" = "Passing both intersects them: the governments in {.arg govid} that also match {.arg state}/{.arg type}."
|
||||||
|
), class = "uscogdata_no_cohort")
|
||||||
|
}
|
||||||
|
structure(
|
||||||
|
list(
|
||||||
|
ids = govid,
|
||||||
|
state = state,
|
||||||
|
type = type,
|
||||||
|
state_fips = if (is.null(state)) NULL else .coerce_state_to_fips(state),
|
||||||
|
type_int = if (is.null(type)) NULL else .coerce_type(type)
|
||||||
|
),
|
||||||
|
class = "uscogdata_cohort"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#' Is any part of this cohort expressed as an xwalk predicate?
|
||||||
|
#' @noRd
|
||||||
|
.cohort_by_predicate <- function(cohort) {
|
||||||
|
!is.null(cohort$state_fips) || !is.null(cohort$type_int)
|
||||||
|
}
|
||||||
|
|
||||||
|
#' Render the cohort as a SQL boolean expression over `col`.
|
||||||
|
#'
|
||||||
|
#' `col` may be qualified (`"l.canonical_govid"`, `"x.canonical_govid"`) --
|
||||||
|
#' several call sites join the xwalk under an alias. The subquery's own
|
||||||
|
#' projected column stays unqualified: it selects from canonical_fips_xwalk,
|
||||||
|
#' not from the outer relation.
|
||||||
|
#' @noRd
|
||||||
|
.cohort_sql <- function(cohort, col = "canonical_govid") {
|
||||||
|
preds <- character(0)
|
||||||
|
|
||||||
|
if (!is.null(cohort$ids)) {
|
||||||
|
preds <- c(preds, sprintf("%s IN (%s)", col, .sql_lit_chr(cohort$ids)))
|
||||||
|
}
|
||||||
|
|
||||||
|
if (.cohort_by_predicate(cohort)) {
|
||||||
|
xwalk_preds <- character(0)
|
||||||
|
if (!is.null(cohort$state_fips)) {
|
||||||
|
xwalk_preds <- c(xwalk_preds,
|
||||||
|
sprintf("fips_state = %s", .sql_lit_chr(cohort$state_fips)))
|
||||||
|
}
|
||||||
|
if (!is.null(cohort$type_int)) {
|
||||||
|
xwalk_preds <- c(xwalk_preds, sprintf("govs_type = %d", cohort$type_int))
|
||||||
|
}
|
||||||
|
preds <- c(preds, sprintf(
|
||||||
|
"%s IN (SELECT canonical_govid FROM canonical_fips_xwalk WHERE %s)",
|
||||||
|
col, paste(xwalk_preds, collapse = " AND ")
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
paste(preds, collapse = " AND ")
|
||||||
|
}
|
||||||
|
|
||||||
|
#' How many governments the cohort covers.
|
||||||
|
#'
|
||||||
|
#' One COUNT against the crosswalk, used only to populate the provenance
|
||||||
|
#' `scope$cohort` block. Deliberately a count rather than the id list: a
|
||||||
|
#' fleet-scale cohort would otherwise put 20,000 ids into every response body,
|
||||||
|
#' which is the cost this issue exists to remove.
|
||||||
|
#' @noRd
|
||||||
|
.cohort_count <- function(con, cohort) {
|
||||||
|
sql <- sprintf(
|
||||||
|
"SELECT COUNT(*) AS n FROM canonical_fips_xwalk WHERE %s",
|
||||||
|
.cohort_sql(cohort)
|
||||||
|
)
|
||||||
|
as.integer(DBI::dbGetQuery(con, sql)$n[[1]])
|
||||||
|
}
|
||||||
|
|
||||||
|
#' The provenance `scope$cohort` block for a predicate cohort, or NULL when
|
||||||
|
#' the cohort was named by id alone (in which case `govids_found`/
|
||||||
|
#' `govids_missing` already describe it exactly).
|
||||||
|
#' @noRd
|
||||||
|
.cohort_provenance <- function(con, cohort) {
|
||||||
|
if (!.cohort_by_predicate(cohort)) return(NULL)
|
||||||
|
list(
|
||||||
|
state = if (is.null(cohort$state)) NA_character_ else as.character(cohort$state),
|
||||||
|
type = if (is.null(cohort$type)) NA_character_ else as.character(cohort$type),
|
||||||
|
n_governments = .cohort_count(con, cohort)
|
||||||
|
)
|
||||||
|
}
|
||||||
+5
-5
@@ -57,7 +57,7 @@
|
|||||||
#' aggregate rows. Without it the grid would offer cells the verb structurally
|
#' aggregate rows. Without it the grid would offer cells the verb structurally
|
||||||
#' never returns, so every one of them would fill as a phantom $0.
|
#' never returns, so every one of them would fill as a phantom $0.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.completion_grid_sql <- function(subtype_col, govid, years, category,
|
.completion_grid_sql <- function(subtype_col, cohort, years, category,
|
||||||
subtype_scope) {
|
subtype_scope) {
|
||||||
category_pred <- if (is.null(category)) {
|
category_pred <- if (is.null(category)) {
|
||||||
""
|
""
|
||||||
@@ -76,13 +76,13 @@
|
|||||||
JOIN canonical_fips_xwalk x ON x.govs_type = cs.type
|
JOIN canonical_fips_xwalk x ON x.govs_type = cs.type
|
||||||
JOIN summary_categories c ON c.item_code = cs.item_code
|
JOIN summary_categories c ON c.item_code = cs.item_code
|
||||||
JOIN representation r ON r.year = cs.year
|
JOIN representation r ON r.year = cs.year
|
||||||
WHERE x.canonical_govid IN (%2$s)
|
WHERE %2$s
|
||||||
AND cs.year IN (%3$s)
|
AND cs.year IN (%3$s)
|
||||||
AND NOT cs.is_aggregate
|
AND NOT cs.is_aggregate
|
||||||
AND c.category IS NOT NULL
|
AND c.category IS NOT NULL
|
||||||
AND c.%1$s IN (%4$s)
|
AND c.%1$s IN (%4$s)
|
||||||
%5$s",
|
%5$s",
|
||||||
subtype_col, .sql_lit_chr(govid),
|
subtype_col, .cohort_sql(cohort, "x.canonical_govid"),
|
||||||
paste(as.integer(years), collapse = ","),
|
paste(as.integer(years), collapse = ","),
|
||||||
.sql_lit_chr(subtype_scope), category_pred
|
.sql_lit_chr(subtype_scope), category_pred
|
||||||
)
|
)
|
||||||
@@ -94,10 +94,10 @@
|
|||||||
#' provenance block. Reported rows are passed through untouched -- filling
|
#' provenance block. Reported rows are passed through untouched -- filling
|
||||||
#' must never alter or drop what the corpus actually published.
|
#' must never alter or drop what the corpus actually published.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.complete_result <- function(result, con, subtype_col, govid, years, category,
|
.complete_result <- function(result, con, subtype_col, cohort, years, category,
|
||||||
subtype_scope) {
|
subtype_scope) {
|
||||||
grid <- tibble::as_tibble(DBI::dbGetQuery(
|
grid <- tibble::as_tibble(DBI::dbGetQuery(
|
||||||
con, .completion_grid_sql(subtype_col, govid, years, category, subtype_scope)
|
con, .completion_grid_sql(subtype_col, cohort, years, category, subtype_scope)
|
||||||
))
|
))
|
||||||
|
|
||||||
result$value_source <- rep("reported", nrow(result))
|
result$value_source <- rep("reported", nrow(result))
|
||||||
|
|||||||
+60
-1
@@ -18,7 +18,15 @@
|
|||||||
# Nextcloud share or a local copy made by cog_mirror().
|
# Nextcloud share or a local copy made by cog_mirror().
|
||||||
url = "https://huggingface.co/datasets/civilytics/us-cog-finance/resolve/main/",
|
url = "https://huggingface.co/datasets/civilytics/us-cog-finance/resolve/main/",
|
||||||
cache_dir = NULL,
|
cache_dir = NULL,
|
||||||
manifest_ttl_secs = 3600L
|
manifest_ttl_secs = 3600L,
|
||||||
|
# NULL means "emit no pragma", which leaves DuckDB's own defaults intact:
|
||||||
|
# every visible core, and 80% of RAM. That is right for one interactive
|
||||||
|
# session on a dedicated machine and wrong for a server, where several
|
||||||
|
# readers share a box and each would otherwise claim all of it. See
|
||||||
|
# .resolve_duckdb_threads() for why this is a supported option rather than
|
||||||
|
# something a consumer reaches into the namespace to set.
|
||||||
|
duckdb_threads = NULL,
|
||||||
|
duckdb_memory_limit = NULL
|
||||||
)
|
)
|
||||||
|
|
||||||
#' Resolve a config value: env var > option > default
|
#' Resolve a config value: env var > option > default
|
||||||
@@ -61,3 +69,54 @@
|
|||||||
v <- .cfg("cache_dir")
|
v <- .cfg("cache_dir")
|
||||||
if (is.null(v)) tools::R_user_dir("uscogdata", "cache") else v
|
if (is.null(v)) tools::R_user_dir("uscogdata", "cache") else v
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#' Resolve the DuckDB thread cap, or NULL to leave DuckDB's default alone.
|
||||||
|
#'
|
||||||
|
#' `cog_open()` used to connect with a bare `dbConnect()` and set no `threads`
|
||||||
|
#' pragma, so DuckDB claimed every core it could see. cog-api works around that
|
||||||
|
#' by reaching into this namespace at boot --
|
||||||
|
#' `getFromNamespace(".ensure_session", "uscogdata")()` followed by a manual
|
||||||
|
#' `SET threads` -- which depends on a private name and on the session already
|
||||||
|
#' being open. Making it a resolved option removes the reason to do that.
|
||||||
|
#'
|
||||||
|
#' `.cfg()` returns an environment variable as CHARACTER, so this coerces
|
||||||
|
#' rather than trusting the type: `USCOGDATA_DUCKDB_THREADS=4` arrives as "4",
|
||||||
|
#' and `sprintf("SET threads TO %d", "4")` would abort inside the connection
|
||||||
|
#' path with an error about the pragma rather than about the setting.
|
||||||
|
#' @noRd
|
||||||
|
.resolve_duckdb_threads <- function() {
|
||||||
|
v <- .cfg("duckdb_threads")
|
||||||
|
if (is.null(v) || (is.character(v) && !nzchar(v))) return(NULL)
|
||||||
|
n <- suppressWarnings(as.integer(v))
|
||||||
|
if (length(n) != 1L || is.na(n) || n < 1L) {
|
||||||
|
cli::cli_abort(c(
|
||||||
|
"{.envvar USCOGDATA_DUCKDB_THREADS} must be a single positive integer.",
|
||||||
|
x = "Got {.val {v}}.",
|
||||||
|
i = "Unset it (or {.code options(uscogdata.duckdb_threads = NULL)}) to use DuckDB's default of every visible core."
|
||||||
|
), class = "uscogdata_invalid_duckdb_threads")
|
||||||
|
}
|
||||||
|
n
|
||||||
|
}
|
||||||
|
|
||||||
|
#' Resolve the DuckDB memory limit, or NULL to leave DuckDB's default alone.
|
||||||
|
#'
|
||||||
|
#' The value is a DuckDB size string (`"4GB"`, `"512MB"`). Only its SHAPE is
|
||||||
|
#' checked here -- DuckDB owns the unit vocabulary, and re-implementing that
|
||||||
|
#' parse would be a second definition free to drift from the engine's. An
|
||||||
|
#' unrecognised unit therefore surfaces as DuckDB's own error at `SET` time,
|
||||||
|
#' which names the setting correctly; the check here exists to reject the
|
||||||
|
#' inputs that would otherwise reach the connection as a SQL fragment.
|
||||||
|
#' @noRd
|
||||||
|
.resolve_duckdb_memory_limit <- function() {
|
||||||
|
v <- .cfg("duckdb_memory_limit")
|
||||||
|
if (is.null(v) || (is.character(v) && !nzchar(v))) return(NULL)
|
||||||
|
if (length(v) != 1L || !is.character(v) ||
|
||||||
|
!grepl("^[0-9]+(\\.[0-9]+)?\\s*[A-Za-z]{0,3}$", v)) {
|
||||||
|
cli::cli_abort(c(
|
||||||
|
"{.envvar USCOGDATA_DUCKDB_MEMORY_LIMIT} must be a single DuckDB size string.",
|
||||||
|
x = "Got {.val {v}}.",
|
||||||
|
i = "Examples: {.val 4GB}, {.val 512MB}, {.val 1.5GB}."
|
||||||
|
), class = "uscogdata_invalid_duckdb_memory_limit")
|
||||||
|
}
|
||||||
|
trimws(v)
|
||||||
|
}
|
||||||
|
|||||||
+3
-3
@@ -113,7 +113,7 @@ cog_recipes <- function(pattern = NULL) {
|
|||||||
#' `year_min`/`year_max` -- so there is no double-counting. (Checkpoint
|
#' `year_min`/`year_max` -- so there is no double-counting. (Checkpoint
|
||||||
#' review docs/phase_r_harmonization_review.md § 0.2.)
|
#' review docs/phase_r_harmonization_review.md § 0.2.)
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.run_recipe <- function(con, recipe_id, govid, years) {
|
.run_recipe <- function(con, recipe_id, cohort, years) {
|
||||||
sql <- sprintf(
|
sql <- sprintf(
|
||||||
"SELECT l.year, l.canonical_govid,
|
"SELECT l.year, l.canonical_govid,
|
||||||
COALESCE(x.gov_name, l.gov_name) AS gov_name,
|
COALESCE(x.gov_name, l.gov_name) AS gov_name,
|
||||||
@@ -128,11 +128,11 @@ cog_recipes <- function(pattern = NULL) {
|
|||||||
OR (r.gov_type_scope = 'local' AND l.type BETWEEN 1 AND 3))
|
OR (r.gov_type_scope = 'local' AND l.type BETWEEN 1 AND 3))
|
||||||
LEFT JOIN canonical_fips_xwalk x USING (canonical_govid)
|
LEFT JOIN canonical_fips_xwalk x USING (canonical_govid)
|
||||||
WHERE r.recipe_id = %1$s
|
WHERE r.recipe_id = %1$s
|
||||||
AND l.canonical_govid IN (%2$s)
|
AND %2$s
|
||||||
AND l.year IN (%3$s)
|
AND l.year IN (%3$s)
|
||||||
GROUP BY 1, 2, 3
|
GROUP BY 1, 2, 3
|
||||||
ORDER BY 1, 2",
|
ORDER BY 1, 2",
|
||||||
.sql_lit_chr(recipe_id), .sql_lit_chr(govid),
|
.sql_lit_chr(recipe_id), .cohort_sql(cohort, "l.canonical_govid"),
|
||||||
paste(as.integer(years), collapse = ",")
|
paste(as.integer(years), collapse = ",")
|
||||||
)
|
)
|
||||||
result <- tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
result <- tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
||||||
|
|||||||
+6
-3
@@ -50,11 +50,12 @@
|
|||||||
#' optional `pop_source`, `codes_included`, `aggregate_fallback`, `notes`,
|
#' optional `pop_source`, `codes_included`, `aggregate_fallback`, `notes`,
|
||||||
#' and `value_source` when `complete = TRUE`.
|
#' and `value_source` when `complete = TRUE`.
|
||||||
#' @export
|
#' @export
|
||||||
cog_revenue <- function(govid, years, category = NULL,
|
cog_revenue <- function(govid = NULL, years, category = NULL,
|
||||||
per_capita = FALSE, adjust_to_year = NULL,
|
per_capita = FALSE, adjust_to_year = NULL,
|
||||||
basis = c("harmonized", "raw"), recipe = NULL,
|
basis = c("harmonized", "raw"), recipe = NULL,
|
||||||
revenue_concept = c("general", "total"),
|
revenue_concept = c("general", "total"),
|
||||||
complete = FALSE, limit = NULL, offset = NULL) {
|
complete = FALSE, limit = NULL, offset = NULL,
|
||||||
|
state = NULL, type = NULL) {
|
||||||
# flow_prefixes no longer classifies rows (crosswalk revenue_subtype
|
# flow_prefixes no longer classifies rows (crosswalk revenue_subtype
|
||||||
# membership does -- General Revenue, i.e. everything except
|
# membership does -- General Revenue, i.e. everything except
|
||||||
# insurance_trust) -- it only scopes the recipe-suggestion machinery to
|
# insurance_trust) -- it only scopes the recipe-suggestion machinery to
|
||||||
@@ -75,6 +76,8 @@ cog_revenue <- function(govid, years, category = NULL,
|
|||||||
revenue_concept = revenue_concept,
|
revenue_concept = revenue_concept,
|
||||||
complete = complete,
|
complete = complete,
|
||||||
limit = limit,
|
limit = limit,
|
||||||
offset = offset
|
offset = offset,
|
||||||
|
state = state,
|
||||||
|
type = type
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
+11
-4
@@ -184,11 +184,18 @@ cog_gov_search <- function(name = NULL, state = NULL, type = NULL) {
|
|||||||
if (!is.character(state) || length(state) != 1L) {
|
if (!is.character(state) || length(state) != 1L) {
|
||||||
cli::cli_abort("`state` must be a 2-letter USPS abbrev or a FIPS integer.")
|
cli::cli_abort("`state` must be a 2-letter USPS abbrev or a FIPS integer.")
|
||||||
}
|
}
|
||||||
fips <- .state_abbrev_to_fips[[toupper(state)]]
|
# Membership tested before the lookup, not after: `.state_abbrev_to_fips` is
|
||||||
if (is.null(fips)) {
|
# a named CHARACTER vector, and `[[` on a name it does not carry throws
|
||||||
cli::cli_abort("Unknown state abbreviation: {state}.")
|
# base R's "subscript out of bounds" rather than returning NULL -- which
|
||||||
|
# made the curated message below unreachable dead code. Reported as a bare
|
||||||
|
# subscript error, `cog_gov_search(state = "ZZ")` gave no hint that the
|
||||||
|
# argument wants a postal abbreviation.
|
||||||
|
key <- toupper(state)
|
||||||
|
if (!key %in% names(.state_abbrev_to_fips)) {
|
||||||
|
cli::cli_abort("Unknown state abbreviation: {state}.",
|
||||||
|
class = "uscogdata_unknown_state")
|
||||||
}
|
}
|
||||||
fips
|
.state_abbrev_to_fips[[key]]
|
||||||
}
|
}
|
||||||
|
|
||||||
# USPS state / territory abbreviation -> 2-digit FIPS code.
|
# USPS state / territory abbreviation -> 2-digit FIPS code.
|
||||||
|
|||||||
+31
-1
@@ -2,13 +2,23 @@
|
|||||||
|
|
||||||
#' Internal: open session, register views, cache manifest.
|
#' Internal: open session, register views, cache manifest.
|
||||||
#' Not exported. Called lazily by verbs via .ensure_session().
|
#' Not exported. Called lazily by verbs via .ensure_session().
|
||||||
|
#'
|
||||||
|
#' `threads` and `memory_limit` default to the resolved configuration and are
|
||||||
|
#' applied as pragmas on the new connection. When both resolve to NULL -- which
|
||||||
|
#' is the case unless the operator sets one -- NO pragma is issued at all, so an
|
||||||
|
#' unconfigured session connects exactly as it did before this argument existed.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
cog_open <- function(url = .resolve_url(),
|
cog_open <- function(url = .resolve_url(),
|
||||||
cache_dir = .resolve_cache_dir()) {
|
cache_dir = .resolve_cache_dir(),
|
||||||
|
threads = .resolve_duckdb_threads(),
|
||||||
|
memory_limit = .resolve_duckdb_memory_limit()) {
|
||||||
.check_url_configured(url)
|
.check_url_configured(url)
|
||||||
if (!dir.exists(cache_dir)) dir.create(cache_dir, recursive = TRUE)
|
if (!dir.exists(cache_dir)) dir.create(cache_dir, recursive = TRUE)
|
||||||
|
|
||||||
con <- DBI::dbConnect(duckdb::duckdb())
|
con <- DBI::dbConnect(duckdb::duckdb())
|
||||||
|
# Before anything else touches the connection: httpfs reads the corpus, and
|
||||||
|
# a remote read should already be bound by whatever budget the operator set.
|
||||||
|
.apply_duckdb_limits(con, threads, memory_limit)
|
||||||
DBI::dbExecute(con, "INSTALL httpfs; LOAD httpfs;")
|
DBI::dbExecute(con, "INSTALL httpfs; LOAD httpfs;")
|
||||||
|
|
||||||
manifest <- .fetch_or_cache_manifest(url, cache_dir)
|
manifest <- .fetch_or_cache_manifest(url, cache_dir)
|
||||||
@@ -25,6 +35,26 @@ cog_open <- function(url = .resolve_url(),
|
|||||||
invisible(con)
|
invisible(con)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#' Apply the operator's DuckDB resource budget to a fresh connection.
|
||||||
|
#'
|
||||||
|
#' Split out from cog_open() so the "unset changes nothing" property is one
|
||||||
|
#' readable branch rather than two conditionals buried in the connection path.
|
||||||
|
#' Both settings are session-scoped in DuckDB, so this must run per connection;
|
||||||
|
#' cog_close() discards the connection and the next cog_open() re-resolves,
|
||||||
|
#' which is what makes a changed option take effect on the next session.
|
||||||
|
#' @noRd
|
||||||
|
.apply_duckdb_limits <- function(con, threads, memory_limit) {
|
||||||
|
if (!is.null(threads)) {
|
||||||
|
DBI::dbExecute(con, sprintf("SET threads TO %d", threads))
|
||||||
|
}
|
||||||
|
if (!is.null(memory_limit)) {
|
||||||
|
# Quoted as a string literal: DuckDB's memory_limit takes '4GB', not 4GB.
|
||||||
|
DBI::dbExecute(con, sprintf("SET memory_limit TO %s",
|
||||||
|
.sql_lit_chr(memory_limit)))
|
||||||
|
}
|
||||||
|
invisible(con)
|
||||||
|
}
|
||||||
|
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.ensure_session <- function() {
|
.ensure_session <- function() {
|
||||||
if (is.null(.uscogdata_env$con) ||
|
if (is.null(.uscogdata_env$con) ||
|
||||||
|
|||||||
+74
-20
@@ -68,7 +68,9 @@
|
|||||||
#' millions/billions). The conversion is recorded in the provenance attribute
|
#' millions/billions). The conversion is recorded in the provenance attribute
|
||||||
#' under `transformations$units_conversion`.
|
#' under `transformations$units_conversion`.
|
||||||
#'
|
#'
|
||||||
#' @param govid Character vector of `canonical_govid` values.
|
#' @param govid Character vector of `canonical_govid` values, or `NULL` to name
|
||||||
|
#' the cohort by `state`/`type` instead. One of `govid`, `state`, or `type`
|
||||||
|
#' is required.
|
||||||
#' @param years Integer vector of years.
|
#' @param years Integer vector of years.
|
||||||
#' @param category Character vector of category names (from
|
#' @param category Character vector of category names (from
|
||||||
#' `summary_categories.category`), or `NULL` for all categories broken out
|
#' `summary_categories.category`), or `NULL` for all categories broken out
|
||||||
@@ -185,6 +187,29 @@
|
|||||||
#' `recipe` and with `complete = TRUE` -- see `offset` and `total_rows`.
|
#' `recipe` and with `complete = TRUE` -- see `offset` and `total_rows`.
|
||||||
#' @param offset Rows to skip before `limit` starts counting (0-based).
|
#' @param offset Rows to skip before `limit` starts counting (0-based).
|
||||||
#' Ignored if `limit` is `NULL`; defaults to `0L` when `limit` is set.
|
#' Ignored if `limit` is `NULL`; defaults to `0L` when `limit` is set.
|
||||||
|
#' @param state,type Name the cohort by predicate instead of by id: `state` is
|
||||||
|
#' a 2-letter USPS abbreviation (or a FIPS code) and `type` is one of
|
||||||
|
#' `"state"`, `"county"`, `"city"`, `"township"` (or the integer `0:3`) --
|
||||||
|
#' the same vocabulary, and the same internal coercion, as
|
||||||
|
#' [cog_gov_search()]. Both default to `NULL`.
|
||||||
|
#'
|
||||||
|
#' The cohort is then expressed as a subquery against `canonical_fips_xwalk`
|
||||||
|
#' inside each statement rather than round-tripped through R as a literal id
|
||||||
|
#' list. For a fleet-scale cohort that is the difference between a
|
||||||
|
#' 301,591-character `IN` list re-parsed in 5--8 statements per call and a
|
||||||
|
#' constant-size predicate: measured at **94 ms versus 449 ms** for the same
|
||||||
|
#' FY2022 aggregate over the 20,106-government `type = "city"` cohort, within
|
||||||
|
#' 7% of the no-filter floor.
|
||||||
|
#'
|
||||||
|
#' Supplying `govid` **and** `state`/`type` INTERSECTS them -- the
|
||||||
|
#' governments in `govid` that also match the predicate -- rather than one
|
||||||
|
#' silently taking precedence. Naming no cohort at all (`govid`, `state` and
|
||||||
|
#' `type` all `NULL`) aborts with class `uscogdata_no_cohort`.
|
||||||
|
#'
|
||||||
|
#' When the cohort is named by predicate, `provenance$scope$govids_found`
|
||||||
|
#' and `govids_missing` are empty -- there is no id list to report against --
|
||||||
|
#' and `provenance$scope$cohort` carries `state`, `type` and
|
||||||
|
#' `n_governments` instead. A `govid`-named cohort reports exactly as before.
|
||||||
#' @return Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
#' @return Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
||||||
#' `spend_subtype`, `category`, `amt_nominal`, optional `amt_real`,
|
#' `spend_subtype`, `category`, `amt_nominal`, optional `amt_real`,
|
||||||
#' optional `amt_per_capita_nominal`, optional `amt_per_capita_real`,
|
#' optional `amt_per_capita_nominal`, optional `amt_per_capita_real`,
|
||||||
@@ -198,11 +223,12 @@
|
|||||||
#' round trip -- so a caller walking pages never has to ask "how many are
|
#' round trip -- so a caller walking pages never has to ask "how many are
|
||||||
#' there" separately.
|
#' there" separately.
|
||||||
#' @export
|
#' @export
|
||||||
cog_spending <- function(govid, years, category = NULL,
|
cog_spending <- function(govid = NULL, years, category = NULL,
|
||||||
per_capita = FALSE, adjust_to_year = NULL,
|
per_capita = FALSE, adjust_to_year = NULL,
|
||||||
basis = c("harmonized", "raw"), recipe = NULL,
|
basis = c("harmonized", "raw"), recipe = NULL,
|
||||||
expenditure_concept = c("primary", "direct", "total"),
|
expenditure_concept = c("primary", "direct", "total"),
|
||||||
complete = FALSE, limit = NULL, offset = NULL) {
|
complete = FALSE, limit = NULL, offset = NULL,
|
||||||
|
state = NULL, type = NULL) {
|
||||||
# flow_prefixes no longer classifies rows (crosswalk subtype membership
|
# flow_prefixes no longer classifies rows (crosswalk subtype membership
|
||||||
# does, per expenditure_concept) -- it only scopes the recipe-suggestion
|
# does, per expenditure_concept) -- it only scopes the recipe-suggestion
|
||||||
# machinery to this verb's recipe families (see R/suggestions.R; the
|
# machinery to this verb's recipe families (see R/suggestions.R; the
|
||||||
@@ -223,7 +249,9 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
expenditure_concept = expenditure_concept,
|
expenditure_concept = expenditure_concept,
|
||||||
complete = complete,
|
complete = complete,
|
||||||
limit = limit,
|
limit = limit,
|
||||||
offset = offset
|
offset = offset,
|
||||||
|
state = state,
|
||||||
|
type = type
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -251,7 +279,8 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
basis = c("harmonized", "raw"), recipe = NULL,
|
basis = c("harmonized", "raw"), recipe = NULL,
|
||||||
expenditure_concept = c("primary", "direct", "total"),
|
expenditure_concept = c("primary", "direct", "total"),
|
||||||
revenue_concept = c("general", "total"),
|
revenue_concept = c("general", "total"),
|
||||||
complete = FALSE, limit = NULL, offset = NULL) {
|
complete = FALSE, limit = NULL, offset = NULL,
|
||||||
|
state = NULL, type = NULL) {
|
||||||
basis_explicit <- length(basis) == 1L
|
basis_explicit <- length(basis) == 1L
|
||||||
basis <- match.arg(basis, c("harmonized", "raw"))
|
basis <- match.arg(basis, c("harmonized", "raw"))
|
||||||
# match.arg() itself throws a base `simpleError`, not an rlang-classed
|
# match.arg() itself throws a base `simpleError`, not an rlang-classed
|
||||||
@@ -291,7 +320,10 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
.revenue_concept_subtypes(revenue_concept)
|
.revenue_concept_subtypes(revenue_concept)
|
||||||
}
|
}
|
||||||
|
|
||||||
govid <- .coerce_govid_input(govid, arg = "govid")
|
# NULL `govid` means "the cohort is named by predicate"; anything else is
|
||||||
|
# coerced and validated exactly as before, so an empty or wrong-typed vector
|
||||||
|
# still fails with its original message rather than being read as absent.
|
||||||
|
govid <- if (is.null(govid)) NULL else .coerce_govid_input(govid, arg = "govid")
|
||||||
# allow_all_categories = TRUE: cog_spending()/cog_revenue() are the two
|
# allow_all_categories = TRUE: cog_spending()/cog_revenue() are the two
|
||||||
# verbs the reserved pseudo-category is defined for. cog_balances() shares
|
# verbs the reserved pseudo-category is defined for. cog_balances() shares
|
||||||
# this validator but leaves the argument at its FALSE default, so it
|
# this validator but leaves the argument at its FALSE default, so it
|
||||||
@@ -300,6 +332,10 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
.validate_verb_inputs(govid, years, category, per_capita, adjust_to_year,
|
.validate_verb_inputs(govid, years, category, per_capita, adjust_to_year,
|
||||||
recipe, allow_all_categories = TRUE)
|
recipe, allow_all_categories = TRUE)
|
||||||
|
|
||||||
|
# Built after validation so the argument-shape errors above keep firing
|
||||||
|
# first, and before .ensure_session() so a bad state/type costs no I/O.
|
||||||
|
cohort <- .make_cohort(govid, state, type)
|
||||||
|
|
||||||
# Recognize the reserved pseudo-category. Detected after type validation so a
|
# Recognize the reserved pseudo-category. Detected after type validation so a
|
||||||
# non-character `category` still fails with the ordinary type error.
|
# non-character `category` still fails with the ordinary type error.
|
||||||
all_categories <- !is.null(category) && .ALL_CATEGORIES %in% category
|
all_categories <- !is.null(category) && .ALL_CATEGORIES %in% category
|
||||||
@@ -407,7 +443,7 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
.validate_recipe_id(con, recipe)
|
.validate_recipe_id(con, recipe)
|
||||||
comps <- .recipe_components(con, recipe)
|
comps <- .recipe_components(con, recipe)
|
||||||
recipe_label <- comps$label[[1]]
|
recipe_label <- comps$label[[1]]
|
||||||
result <- .run_recipe(con, recipe, govid, years)
|
result <- .run_recipe(con, recipe, cohort, years)
|
||||||
sql <- attr(result, "sql_query")
|
sql <- attr(result, "sql_query")
|
||||||
result <- .shape_recipe_result(result, subtype_col, recipe_label)
|
result <- .shape_recipe_result(result, subtype_col, recipe_label)
|
||||||
recipe_block <- list(
|
recipe_block <- list(
|
||||||
@@ -423,7 +459,7 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
} else {
|
} else {
|
||||||
NULL
|
NULL
|
||||||
}
|
}
|
||||||
sql <- .build_verb_sql(view, subtype_col, govid, years,
|
sql <- .build_verb_sql(view, subtype_col, cohort, years,
|
||||||
if (all_categories) NULL else category,
|
if (all_categories) NULL else category,
|
||||||
ig_view, subtype_scope,
|
ig_view, subtype_scope,
|
||||||
all_categories = all_categories,
|
all_categories = all_categories,
|
||||||
@@ -441,7 +477,7 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
} else {
|
} else {
|
||||||
count_sql <- sprintf(
|
count_sql <- sprintf(
|
||||||
"SELECT COUNT(*) AS n FROM (%s) AS _uncounted",
|
"SELECT COUNT(*) AS n FROM (%s) AS _uncounted",
|
||||||
.build_verb_sql(view, subtype_col, govid, years,
|
.build_verb_sql(view, subtype_col, cohort, years,
|
||||||
if (all_categories) NULL else category,
|
if (all_categories) NULL else category,
|
||||||
ig_view, subtype_scope,
|
ig_view, subtype_scope,
|
||||||
all_categories = all_categories)
|
all_categories = all_categories)
|
||||||
@@ -457,13 +493,13 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
# spurious 0.
|
# spurious 0.
|
||||||
completion <- list(applied = FALSE, rows_filled = 0L, absence_means = list())
|
completion <- list(applied = FALSE, rows_filled = 0L, absence_means = list())
|
||||||
if (complete) {
|
if (complete) {
|
||||||
result <- .complete_result(result, con, subtype_col, govid, years,
|
result <- .complete_result(result, con, subtype_col, cohort, years,
|
||||||
category, subtype_scope)
|
category, subtype_scope)
|
||||||
completion <- attr(result, ".completion")
|
completion <- attr(result, ".completion")
|
||||||
attr(result, ".completion") <- NULL
|
attr(result, ".completion") <- NULL
|
||||||
}
|
}
|
||||||
|
|
||||||
if (per_capita) result <- .attach_per_capita(result, con, govid)
|
if (per_capita) result <- .attach_per_capita(result, con)
|
||||||
if (!is.null(adjust_to_year)) {
|
if (!is.null(adjust_to_year)) {
|
||||||
result <- .attach_real_dollars(result, adjust_to_year, per_capita)
|
result <- .attach_real_dollars(result, adjust_to_year, per_capita)
|
||||||
}
|
}
|
||||||
@@ -491,7 +527,7 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
basis_for_prov <- resolved$basis
|
basis_for_prov <- resolved$basis
|
||||||
basis_note_for_prov <- resolved$note
|
basis_note_for_prov <- resolved$note
|
||||||
harmonization <- .build_harmonization_block(
|
harmonization <- .build_harmonization_block(
|
||||||
con, govid, years, resolved, subtype_col, subtype_scope
|
con, cohort, years, resolved, subtype_col, subtype_scope
|
||||||
)
|
)
|
||||||
# C1(a): gap detection must run against the Direct leg alone. `result`
|
# C1(a): gap detection must run against the Direct leg alone. `result`
|
||||||
# can also carry UNION'd intergovernmental rows (expenditure_concept =
|
# can also carry UNION'd intergovernmental rows (expenditure_concept =
|
||||||
@@ -506,7 +542,7 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
} else {
|
} else {
|
||||||
result
|
result
|
||||||
}
|
}
|
||||||
suggestions <- .build_suggestions(con, govid, years, category,
|
suggestions <- .build_suggestions(con, cohort, years, category,
|
||||||
direct_leg_result,
|
direct_leg_result,
|
||||||
resolved$basis, flow_prefixes,
|
resolved$basis, flow_prefixes,
|
||||||
.select_long_view(view_base, resolved$basis),
|
.select_long_view(view_base, resolved$basis),
|
||||||
@@ -611,6 +647,12 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
)
|
)
|
||||||
prov$scope$govids_found <- scope$found
|
prov$scope$govids_found <- scope$found
|
||||||
prov$scope$govids_missing <- scope$missing
|
prov$scope$govids_missing <- scope$missing
|
||||||
|
# A predicate-named cohort has no id list to report found/missing against
|
||||||
|
# (both stay empty), so it describes itself instead. Deliberately a COUNT
|
||||||
|
# rather than the resolved ids: enumerating them would put 20,000 govids in
|
||||||
|
# every fleet-scale response body, which is the cost this path exists to
|
||||||
|
# remove. NULL for a govid-named cohort, so that output is untouched.
|
||||||
|
prov$scope$cohort <- .cohort_provenance(con, cohort)
|
||||||
attr(result, "provenance") <- prov
|
attr(result, "provenance") <- prov
|
||||||
attr(result, ".popyear_range") <- NULL
|
attr(result, ".popyear_range") <- NULL
|
||||||
# Attached here, after every downstream transform (per_capita/real-dollar
|
# Attached here, after every downstream transform (per_capita/real-dollar
|
||||||
@@ -639,7 +681,11 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
.validate_verb_inputs <- function(govid, years, category,
|
.validate_verb_inputs <- function(govid, years, category,
|
||||||
per_capita, adjust_to_year, recipe = NULL,
|
per_capita, adjust_to_year, recipe = NULL,
|
||||||
allow_all_categories = FALSE) {
|
allow_all_categories = FALSE) {
|
||||||
if (!is.character(govid) || length(govid) == 0L) {
|
# NULL is allowed only because the caller has already established that the
|
||||||
|
# cohort is named some other way (`state`/`type`); .make_cohort() is what
|
||||||
|
# refuses a call that names no cohort at all. A supplied-but-empty `govid`
|
||||||
|
# still fails here, exactly as before.
|
||||||
|
if (!is.null(govid) && (!is.character(govid) || length(govid) == 0L)) {
|
||||||
cli::cli_abort("`govid` must be a non-empty character vector.")
|
cli::cli_abort("`govid` must be a non-empty character vector.")
|
||||||
}
|
}
|
||||||
if (!(is.integer(years) || is.numeric(years)) || length(years) == 0L) {
|
if (!(is.integer(years) || is.numeric(years)) || length(years) == 0L) {
|
||||||
@@ -740,10 +786,10 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
}
|
}
|
||||||
|
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.build_verb_sql <- function(view, subtype_col, govid, years, category,
|
.build_verb_sql <- function(view, subtype_col, cohort, years, category,
|
||||||
ig_view = NULL, subtype_scope = NULL,
|
ig_view = NULL, subtype_scope = NULL,
|
||||||
all_categories = FALSE, limit = NULL, offset = NULL) {
|
all_categories = FALSE, limit = NULL, offset = NULL) {
|
||||||
govid_lit <- .sql_lit_chr(govid)
|
cohort_pred <- .cohort_sql(cohort)
|
||||||
years_lit <- paste(as.integer(years), collapse = ",")
|
years_lit <- paste(as.integer(years), collapse = ",")
|
||||||
# In all-categories mode there is no category filter: the sum is defined by
|
# In all-categories mode there is no category filter: the sum is defined by
|
||||||
# the concept's SUBTYPE allowlist (subtype_pred below), which is the real
|
# the concept's SUBTYPE allowlist (subtype_pred below), which is the real
|
||||||
@@ -813,13 +859,13 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
string_agg(DISTINCT item_code, ',' ORDER BY item_code) AS codes_included,
|
string_agg(DISTINCT item_code, ',' ORDER BY item_code) AS codes_included,
|
||||||
bool_or(is_aggregate) AS aggregate_fallback
|
bool_or(is_aggregate) AS aggregate_fallback
|
||||||
FROM %2$s
|
FROM %2$s
|
||||||
WHERE canonical_govid IN (%3$s)
|
WHERE %3$s
|
||||||
AND year IN (%4$s)
|
AND year IN (%4$s)
|
||||||
%5$s
|
%5$s
|
||||||
%6$s
|
%6$s
|
||||||
GROUP BY year, canonical_govid, gov_name, xwalk_gov_name, %1$s%8$s
|
GROUP BY year, canonical_govid, gov_name, xwalk_gov_name, %1$s%8$s
|
||||||
ORDER BY year, canonical_govid, %1$s%8$s",
|
ORDER BY year, canonical_govid, %1$s%8$s",
|
||||||
subtype_col, source_expr, govid_lit, years_lit, category_pred, subtype_pred,
|
subtype_col, source_expr, cohort_pred, years_lit, category_pred, subtype_pred,
|
||||||
category_select, category_group
|
category_select, category_group
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -845,8 +891,16 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#' Join population onto a result and derive the per-capita columns.
|
||||||
|
#'
|
||||||
|
#' The population lookup is keyed on the govids PRESENT IN `result`, not on the
|
||||||
|
#' cohort that produced it. Those are the only ones the LEFT JOIN below can
|
||||||
|
#' match, so the joined output is identical either way -- but it means this
|
||||||
|
#' works unchanged for a cohort named by predicate (where no id list exists in
|
||||||
|
#' R at all), and on a paginated call it looks up one page's governments
|
||||||
|
#' instead of the whole fleet's.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.attach_per_capita <- function(result, con, govid) {
|
.attach_per_capita <- function(result, con) {
|
||||||
if (nrow(result) == 0L) {
|
if (nrow(result) == 0L) {
|
||||||
result$amt_per_capita_nominal <- numeric(0)
|
result$amt_per_capita_nominal <- numeric(0)
|
||||||
result$pop_source <- character(0)
|
result$pop_source <- character(0)
|
||||||
@@ -859,7 +913,7 @@ cog_spending <- function(govid, years, category = NULL,
|
|||||||
FROM gov_population_yearly
|
FROM gov_population_yearly
|
||||||
WHERE canonical_govid IN (%s)
|
WHERE canonical_govid IN (%s)
|
||||||
AND year IN (%s)",
|
AND year IN (%s)",
|
||||||
.sql_lit_chr(govid), years_lit
|
.sql_lit_chr(unique(result$canonical_govid)), years_lit
|
||||||
)
|
)
|
||||||
pops <- tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
pops <- tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
||||||
result <- dplyr::left_join(result, pops,
|
result <- dplyr::left_join(result, pops,
|
||||||
|
|||||||
+6
-6
@@ -42,8 +42,8 @@
|
|||||||
#' verb call: recipes whose generic join would fill a real gap in `result`.
|
#' verb call: recipes whose generic join would fill a real gap in `result`.
|
||||||
#'
|
#'
|
||||||
#' @param con Active DuckDB connection.
|
#' @param con Active DuckDB connection.
|
||||||
#' @param govid Character vector of canonical_govid values (the verb's raw
|
#' @param cohort The verb's cohort object (see `.make_cohort()`), naming the
|
||||||
#' `govid`).
|
#' governments by id, by state/type predicate, or both.
|
||||||
#' @param years Integer vector of requested years.
|
#' @param years Integer vector of requested years.
|
||||||
#' @param category `category` argument as passed to the verb (character
|
#' @param category `category` argument as passed to the verb (character
|
||||||
#' vector or `NULL`; suggestions are only computed when non-NULL).
|
#' vector or `NULL`; suggestions are only computed when non-NULL).
|
||||||
@@ -85,7 +85,7 @@
|
|||||||
#' ig_recipe_id, trigger, suppressed_amount, suppressed_years,
|
#' ig_recipe_id, trigger, suppressed_amount, suppressed_years,
|
||||||
#' suppressed_codes)`, possibly empty.
|
#' suppressed_codes)`, possibly empty.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.build_suggestions <- function(con, govid, years, category, result, basis,
|
.build_suggestions <- function(con, cohort, years, category, result, basis,
|
||||||
flow_prefixes, long_view,
|
flow_prefixes, long_view,
|
||||||
all_categories = FALSE,
|
all_categories = FALSE,
|
||||||
subtype_col = NULL, subtype_scope = NULL) {
|
subtype_col = NULL, subtype_scope = NULL) {
|
||||||
@@ -160,7 +160,7 @@
|
|||||||
# violation would kill signposting, the exact failure class uscogdata#9
|
# violation would kill signposting, the exact failure class uscogdata#9
|
||||||
# exists to prevent. Owner's call: keep this simple; a batch-aware
|
# exists to prevent. Owner's call: keep this simple; a batch-aware
|
||||||
# optimization, if one is worth building, is a separate issue.
|
# optimization, if one is worth building, is a separate issue.
|
||||||
supp <- .suppressed_components(con, candidates, govid, years, long_view, flow_prefixes)
|
supp <- .suppressed_components(con, candidates, cohort, years, long_view, flow_prefixes)
|
||||||
|
|
||||||
if (length(gap_years) == 0L && nrow(supp) == 0L) return(list())
|
if (length(gap_years) == 0L && nrow(supp) == 0L) return(list())
|
||||||
|
|
||||||
@@ -188,9 +188,9 @@
|
|||||||
OR (r.gov_type_scope = 'state' AND l.type = 0)
|
OR (r.gov_type_scope = 'state' AND l.type = 0)
|
||||||
OR (r.gov_type_scope = 'local' AND l.type BETWEEN 1 AND 3))
|
OR (r.gov_type_scope = 'local' AND l.type BETWEEN 1 AND 3))
|
||||||
WHERE r.recipe_id IN (%s)
|
WHERE r.recipe_id IN (%s)
|
||||||
AND l.canonical_govid IN (%s)
|
AND %s
|
||||||
AND l.year IN (%s)",
|
AND l.year IN (%s)",
|
||||||
.sql_lit_chr(candidates), .sql_lit_chr(govid),
|
.sql_lit_chr(candidates), .cohort_sql(cohort, "l.canonical_govid"),
|
||||||
paste(gap_years, collapse = ",")
|
paste(gap_years, collapse = ",")
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|||||||
+8
-6
@@ -50,7 +50,9 @@
|
|||||||
#'
|
#'
|
||||||
#' @param con Active DuckDB connection.
|
#' @param con Active DuckDB connection.
|
||||||
#' @param candidates Character vector of recipe ids to measure.
|
#' @param candidates Character vector of recipe ids to measure.
|
||||||
#' @param govid Character vector of canonical_govid values.
|
#' @param cohort The verb's cohort object (see `.make_cohort()`), rendered
|
||||||
|
#' into the govid predicate on both the outer scan and the restated
|
||||||
|
#' NOT EXISTS filter.
|
||||||
#' @param years Integer vector of requested years.
|
#' @param years Integer vector of requested years.
|
||||||
#' @param long_view Name of the verb's long view, from `.select_long_view()`.
|
#' @param long_view Name of the verb's long view, from `.select_long_view()`.
|
||||||
#' @param flow_prefixes The calling verb's own flow-type prefixes (see
|
#' @param flow_prefixes The calling verb's own flow-type prefixes (see
|
||||||
@@ -60,7 +62,7 @@
|
|||||||
#' dollars), `suppressed_codes` (comma-joined, sorted). Zero rows when
|
#' dollars), `suppressed_codes` (comma-joined, sorted). Zero rows when
|
||||||
#' nothing is suppressed.
|
#' nothing is suppressed.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
.suppressed_components <- function(con, candidates, govid, years, long_view,
|
.suppressed_components <- function(con, candidates, cohort, years, long_view,
|
||||||
flow_prefixes) {
|
flow_prefixes) {
|
||||||
empty <- tibble::tibble(
|
empty <- tibble::tibble(
|
||||||
recipe_id = character(0), year = numeric(0),
|
recipe_id = character(0), year = numeric(0),
|
||||||
@@ -93,7 +95,7 @@
|
|||||||
OR (r.gov_type_scope = 'state' AND l.type = 0)
|
OR (r.gov_type_scope = 'state' AND l.type = 0)
|
||||||
OR (r.gov_type_scope = 'local' AND l.type BETWEEN 1 AND 3))
|
OR (r.gov_type_scope = 'local' AND l.type BETWEEN 1 AND 3))
|
||||||
WHERE r.recipe_id IN (%1$s)
|
WHERE r.recipe_id IN (%1$s)
|
||||||
AND l.canonical_govid IN (%2$s)
|
AND %2$s
|
||||||
AND l.year IN (%3$s)
|
AND l.year IN (%3$s)
|
||||||
AND l.amt <> 0
|
AND l.amt <> 0
|
||||||
AND LEFT(r.component_code, 1) IN (%5$s)
|
AND LEFT(r.component_code, 1) IN (%5$s)
|
||||||
@@ -103,13 +105,13 @@
|
|||||||
AND v.year = l.year
|
AND v.year = l.year
|
||||||
AND v.item_code = l.item_code
|
AND v.item_code = l.item_code
|
||||||
AND v.year IN (%3$s) -- restated: enables partition pruning (I3a)
|
AND v.year IN (%3$s) -- restated: enables partition pruning (I3a)
|
||||||
AND v.canonical_govid IN (%2$s) -- restated: pushes the govid filter (I3a)
|
AND %6$s -- restated: pushes the cohort filter (I3a)
|
||||||
)
|
)
|
||||||
GROUP BY 1, 2
|
GROUP BY 1, 2
|
||||||
ORDER BY 1, 2",
|
ORDER BY 1, 2",
|
||||||
.sql_lit_chr(candidates), .sql_lit_chr(govid),
|
.sql_lit_chr(candidates), .cohort_sql(cohort, "l.canonical_govid"),
|
||||||
paste(as.integer(years), collapse = ","), long_view,
|
paste(as.integer(years), collapse = ","), long_view,
|
||||||
.sql_lit_chr(flow_prefixes)
|
.sql_lit_chr(flow_prefixes), .cohort_sql(cohort, "v.canonical_govid")
|
||||||
)
|
)
|
||||||
tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
tibble::as_tibble(DBI::dbGetQuery(con, sql))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -122,9 +122,25 @@
|
|||||||
#' fallback -- correct for the local temp corpora the direct-execution tests
|
#' fallback -- correct for the local temp corpora the direct-execution tests
|
||||||
#' build.
|
#' build.
|
||||||
#' @noRd
|
#' @noRd
|
||||||
|
#' `fixed = TRUE` is load-bearing, not a style choice.
|
||||||
|
#'
|
||||||
|
#' In regex mode, `gsub()` interprets backslashes in the REPLACEMENT string as
|
||||||
|
#' escape sequences and silently drops them. A Windows corpus path is full of
|
||||||
|
#' them, so `C:\Users\RUNNER\AppData\...` was substituted in as
|
||||||
|
#' `C:UsersRUNNERAppData...` and every DuckDB read failed with "No files found
|
||||||
|
#' that match the pattern". `fixed = TRUE` treats pattern and replacement as
|
||||||
|
#' literal text, which is what a filesystem path needs.
|
||||||
|
#'
|
||||||
|
#' This is why the package could not read a LOCAL corpus on Windows at all --
|
||||||
|
#' including the test fixture, hence the entire suite, and any `cog_mirror()`
|
||||||
|
#' copy. Remote https URLs were unaffected, having no backslashes, which is
|
||||||
|
#' part of why it stayed hidden: the bug predates the `{long_files}` token and
|
||||||
|
#' lived in the original `{url}` substitution, unnoticed because nothing ever
|
||||||
|
#' ran on Windows until the mirror's check matrix existed.
|
||||||
|
#' @noRd
|
||||||
.render_view_sql <- function(sql, url, manifest = list()) {
|
.render_view_sql <- function(sql, url, manifest = list()) {
|
||||||
sql <- gsub("\\{long_files\\}", .long_files_sql(url, manifest), sql, fixed = FALSE)
|
sql <- gsub("{long_files}", .long_files_sql(url, manifest), sql, fixed = TRUE)
|
||||||
gsub("\\{url\\}", url, sql, fixed = FALSE)
|
gsub("{url}", url, sql, fixed = TRUE)
|
||||||
}
|
}
|
||||||
|
|
||||||
#' Register DuckDB views from inst/sql/ SQL files
|
#' Register DuckDB views from inst/sql/ SQL files
|
||||||
|
|||||||
@@ -110,6 +110,17 @@ After that, nothing in your analysis touches an external service.
|
|||||||
- `USCOGDATA_URL` — corpus root: an HTTPS URL or a local path, **trailing slash required**
|
- `USCOGDATA_URL` — corpus root: an HTTPS URL or a local path, **trailing slash required**
|
||||||
- `USCOGDATA_CACHE_DIR` — where the manifest is cached (default: user cache dir)
|
- `USCOGDATA_CACHE_DIR` — where the manifest is cached (default: user cache dir)
|
||||||
- `USCOGDATA_MANIFEST_TTL_SECS` — manifest re-fetch interval (default 3600)
|
- `USCOGDATA_MANIFEST_TTL_SECS` — manifest re-fetch interval (default 3600)
|
||||||
|
- `USCOGDATA_DUCKDB_THREADS` — cap DuckDB's thread count (default: every visible core)
|
||||||
|
- `USCOGDATA_DUCKDB_MEMORY_LIMIT` — cap DuckDB's memory, e.g. `"4GB"` (default: DuckDB's own)
|
||||||
|
|
||||||
|
Each also has an `options()` spelling — `uscogdata.url`, `uscogdata.duckdb_threads`,
|
||||||
|
and so on — and the environment variable wins where both are set.
|
||||||
|
|
||||||
|
The two DuckDB caps exist for **servers**, not laptops. Unset, DuckDB claims every
|
||||||
|
core it can see, which is right for one interactive session on your own machine and
|
||||||
|
wrong when several readers share a box: each claims the whole machine and they fight.
|
||||||
|
Capping costs roughly 5% on a single query and is worth it anywhere the process is
|
||||||
|
sharing hardware.
|
||||||
|
|
||||||
## Amounts are in full US dollars
|
## Amounts are in full US dollars
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
+3
-3
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"schema_version": 6,
|
"schema_version": 6,
|
||||||
"built_at": "2026-07-31T00:47:27Z",
|
"built_at": "2026-08-03T16:51:32Z",
|
||||||
"pipeline_commit": "aadb46b",
|
"pipeline_commit": "e7394a4",
|
||||||
"fixture_note": "Four-year (2011, 2012, 2019, 2020) fixture for uscogdata tests. Full corpus available via USCOGDATA_URL. Regenerated from the sparsified schema-v6 corpus: the wide era (<= FY2011) no longer stores explicit zeros, so FY2011 absence means Census published $0 while FY2012+ absence means not reported. representation.parquet and code_set.parquet carry that rule and ship in full, as do every other metadata table in the publish tree. 2011/2012 straddle both the wide-aggregate -> modern-leaf format boundary (exercised by basis=\"harmonized\" and recipe= queries) and the dense -> sparse representation boundary (SB194); 2019/2020 retain the prior per-capita/CPI regression anchors. Regenerated via data-raw/regenerate_fixture_corpus.R.",
|
"fixture_note": "Four-year (2011, 2012, 2019, 2020) fixture for uscogdata tests. Full corpus available via USCOGDATA_URL. Regenerated from the sparsified schema-v6 corpus: the wide era (<= FY2011) no longer stores explicit zeros, so FY2011 absence means Census published $0 while FY2012+ absence means not reported. representation.parquet and code_set.parquet carry that rule and ship in full, as do every other metadata table in the publish tree. 2011/2012 straddle both the wide-aggregate -> modern-leaf format boundary (exercised by basis=\"harmonized\" and recipe= queries) and the dense -> sparse representation boundary (SB194); 2019/2020 retain the prior per-capita/CPI regression anchors. Regenerated via data-raw/regenerate_fixture_corpus.R.",
|
||||||
"data_vintage": {
|
"data_vintage": {
|
||||||
"source_vintages": {
|
"source_vintages": {
|
||||||
@@ -105,7 +105,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "data/series_breaks.parquet",
|
"path": "data/series_breaks.parquet",
|
||||||
"sha256": "06dcc995ff533e57cc65fa25086cc9bf83ba592c58bf7cc99269dc2576f69944",
|
"sha256": "731998516cd802f63fcf7fb66053c7a62b7be955ab0794cad4a4979cb7628b87",
|
||||||
"description": "series_breaks.parquet"
|
"description": "series_breaks.parquet"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
+30
-3
@@ -5,18 +5,21 @@
|
|||||||
\title{Cash and security holdings for one or more governments}
|
\title{Cash and security holdings for one or more governments}
|
||||||
\usage{
|
\usage{
|
||||||
cog_balances(
|
cog_balances(
|
||||||
govid,
|
govid = NULL,
|
||||||
years,
|
years,
|
||||||
category = NULL,
|
category = NULL,
|
||||||
per_capita = FALSE,
|
per_capita = FALSE,
|
||||||
adjust_to_year = NULL,
|
adjust_to_year = NULL,
|
||||||
basis = c("harmonized", "raw"),
|
basis = c("harmonized", "raw"),
|
||||||
recipe = NULL
|
recipe = NULL,
|
||||||
|
state = NULL,
|
||||||
|
type = NULL
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{govid}{Canonical govid(s): a character vector, or a data frame with a
|
\item{govid}{Canonical govid(s): a character vector, or a data frame with a
|
||||||
`canonical_govid` column (e.g. from [cog_gov_search()]).}
|
`canonical_govid` column (e.g. from [cog_gov_search()]). `NULL` to name
|
||||||
|
the cohort by `state`/`type` instead.}
|
||||||
|
|
||||||
\item{years}{Integer vector of fiscal years.}
|
\item{years}{Integer vector of fiscal years.}
|
||||||
|
|
||||||
@@ -49,6 +52,30 @@ and raw space are identical for holdings. Reported in
|
|||||||
\item{recipe}{Optional harmonization recipe id (see [cog_recipes()]).
|
\item{recipe}{Optional harmonization recipe id (see [cog_recipes()]).
|
||||||
`"cash_securities_z77_wide"` and `"cash_securities_z78_wide"` bridge the
|
`"cash_securities_z77_wide"` and `"cash_securities_z78_wide"` bridge the
|
||||||
wide era to the modern one.}
|
wide era to the modern one.}
|
||||||
|
|
||||||
|
\item{state, type}{Name the cohort by predicate instead of by id: `state` is
|
||||||
|
a 2-letter USPS abbreviation (or a FIPS code) and `type` is one of
|
||||||
|
`"state"`, `"county"`, `"city"`, `"township"` (or the integer `0:3`) --
|
||||||
|
the same vocabulary, and the same internal coercion, as
|
||||||
|
[cog_gov_search()]. Both default to `NULL`.
|
||||||
|
|
||||||
|
The cohort is then expressed as a subquery against `canonical_fips_xwalk`
|
||||||
|
inside each statement rather than round-tripped through R as a literal id
|
||||||
|
list. For a fleet-scale cohort that is the difference between a
|
||||||
|
301,591-character `IN` list re-parsed in 5--8 statements per call and a
|
||||||
|
constant-size predicate: measured at **94 ms versus 449 ms** for the same
|
||||||
|
FY2022 aggregate over the 20,106-government `type = "city"` cohort, within
|
||||||
|
7% of the no-filter floor.
|
||||||
|
|
||||||
|
Supplying `govid` **and** `state`/`type` INTERSECTS them -- the
|
||||||
|
governments in `govid` that also match the predicate -- rather than one
|
||||||
|
silently taking precedence. Naming no cohort at all (`govid`, `state` and
|
||||||
|
`type` all `NULL`) aborts with class `uscogdata_no_cohort`.
|
||||||
|
|
||||||
|
When the cohort is named by predicate, `provenance$scope$govids_found`
|
||||||
|
and `govids_missing` are empty -- there is no id list to report against --
|
||||||
|
and `provenance$scope$cohort` carries `state`, `type` and
|
||||||
|
`n_governments` instead. A `govid`-named cohort reports exactly as before.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
||||||
|
|||||||
+31
-3
@@ -5,7 +5,7 @@
|
|||||||
\title{Summarized revenue by category}
|
\title{Summarized revenue by category}
|
||||||
\usage{
|
\usage{
|
||||||
cog_revenue(
|
cog_revenue(
|
||||||
govid,
|
govid = NULL,
|
||||||
years,
|
years,
|
||||||
category = NULL,
|
category = NULL,
|
||||||
per_capita = FALSE,
|
per_capita = FALSE,
|
||||||
@@ -15,11 +15,15 @@ cog_revenue(
|
|||||||
revenue_concept = c("general", "total"),
|
revenue_concept = c("general", "total"),
|
||||||
complete = FALSE,
|
complete = FALSE,
|
||||||
limit = NULL,
|
limit = NULL,
|
||||||
offset = NULL
|
offset = NULL,
|
||||||
|
state = NULL,
|
||||||
|
type = NULL
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{govid}{Character vector of `canonical_govid` values.}
|
\item{govid}{Character vector of `canonical_govid` values, or `NULL` to name
|
||||||
|
the cohort by `state`/`type` instead. One of `govid`, `state`, or `type`
|
||||||
|
is required.}
|
||||||
|
|
||||||
\item{years}{Integer vector of years.}
|
\item{years}{Integer vector of years.}
|
||||||
|
|
||||||
@@ -126,6 +130,30 @@ exactly as before this parameter existed. Mutually exclusive with
|
|||||||
|
|
||||||
\item{offset}{Rows to skip before `limit` starts counting (0-based).
|
\item{offset}{Rows to skip before `limit` starts counting (0-based).
|
||||||
Ignored if `limit` is `NULL`; defaults to `0L` when `limit` is set.}
|
Ignored if `limit` is `NULL`; defaults to `0L` when `limit` is set.}
|
||||||
|
|
||||||
|
\item{state, type}{Name the cohort by predicate instead of by id: `state` is
|
||||||
|
a 2-letter USPS abbreviation (or a FIPS code) and `type` is one of
|
||||||
|
`"state"`, `"county"`, `"city"`, `"township"` (or the integer `0:3`) --
|
||||||
|
the same vocabulary, and the same internal coercion, as
|
||||||
|
[cog_gov_search()]. Both default to `NULL`.
|
||||||
|
|
||||||
|
The cohort is then expressed as a subquery against `canonical_fips_xwalk`
|
||||||
|
inside each statement rather than round-tripped through R as a literal id
|
||||||
|
list. For a fleet-scale cohort that is the difference between a
|
||||||
|
301,591-character `IN` list re-parsed in 5--8 statements per call and a
|
||||||
|
constant-size predicate: measured at **94 ms versus 449 ms** for the same
|
||||||
|
FY2022 aggregate over the 20,106-government `type = "city"` cohort, within
|
||||||
|
7% of the no-filter floor.
|
||||||
|
|
||||||
|
Supplying `govid` **and** `state`/`type` INTERSECTS them -- the
|
||||||
|
governments in `govid` that also match the predicate -- rather than one
|
||||||
|
silently taking precedence. Naming no cohort at all (`govid`, `state` and
|
||||||
|
`type` all `NULL`) aborts with class `uscogdata_no_cohort`.
|
||||||
|
|
||||||
|
When the cohort is named by predicate, `provenance$scope$govids_found`
|
||||||
|
and `govids_missing` are empty -- there is no id list to report against --
|
||||||
|
and `provenance$scope$cohort` carries `state`, `type` and
|
||||||
|
`n_governments` instead. A `govid`-named cohort reports exactly as before.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
||||||
|
|||||||
+31
-3
@@ -5,7 +5,7 @@
|
|||||||
\title{Summarized spending by category}
|
\title{Summarized spending by category}
|
||||||
\usage{
|
\usage{
|
||||||
cog_spending(
|
cog_spending(
|
||||||
govid,
|
govid = NULL,
|
||||||
years,
|
years,
|
||||||
category = NULL,
|
category = NULL,
|
||||||
per_capita = FALSE,
|
per_capita = FALSE,
|
||||||
@@ -15,11 +15,15 @@ cog_spending(
|
|||||||
expenditure_concept = c("primary", "direct", "total"),
|
expenditure_concept = c("primary", "direct", "total"),
|
||||||
complete = FALSE,
|
complete = FALSE,
|
||||||
limit = NULL,
|
limit = NULL,
|
||||||
offset = NULL
|
offset = NULL,
|
||||||
|
state = NULL,
|
||||||
|
type = NULL
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{govid}{Character vector of `canonical_govid` values.}
|
\item{govid}{Character vector of `canonical_govid` values, or `NULL` to name
|
||||||
|
the cohort by `state`/`type` instead. One of `govid`, `state`, or `type`
|
||||||
|
is required.}
|
||||||
|
|
||||||
\item{years}{Integer vector of years.}
|
\item{years}{Integer vector of years.}
|
||||||
|
|
||||||
@@ -146,6 +150,30 @@ exactly as before this parameter existed. Mutually exclusive with
|
|||||||
|
|
||||||
\item{offset}{Rows to skip before `limit` starts counting (0-based).
|
\item{offset}{Rows to skip before `limit` starts counting (0-based).
|
||||||
Ignored if `limit` is `NULL`; defaults to `0L` when `limit` is set.}
|
Ignored if `limit` is `NULL`; defaults to `0L` when `limit` is set.}
|
||||||
|
|
||||||
|
\item{state, type}{Name the cohort by predicate instead of by id: `state` is
|
||||||
|
a 2-letter USPS abbreviation (or a FIPS code) and `type` is one of
|
||||||
|
`"state"`, `"county"`, `"city"`, `"township"` (or the integer `0:3`) --
|
||||||
|
the same vocabulary, and the same internal coercion, as
|
||||||
|
[cog_gov_search()]. Both default to `NULL`.
|
||||||
|
|
||||||
|
The cohort is then expressed as a subquery against `canonical_fips_xwalk`
|
||||||
|
inside each statement rather than round-tripped through R as a literal id
|
||||||
|
list. For a fleet-scale cohort that is the difference between a
|
||||||
|
301,591-character `IN` list re-parsed in 5--8 statements per call and a
|
||||||
|
constant-size predicate: measured at **94 ms versus 449 ms** for the same
|
||||||
|
FY2022 aggregate over the 20,106-government `type = "city"` cohort, within
|
||||||
|
7% of the no-filter floor.
|
||||||
|
|
||||||
|
Supplying `govid` **and** `state`/`type` INTERSECTS them -- the
|
||||||
|
governments in `govid` that also match the predicate -- rather than one
|
||||||
|
silently taking precedence. Naming no cohort at all (`govid`, `state` and
|
||||||
|
`type` all `NULL`) aborts with class `uscogdata_no_cohort`.
|
||||||
|
|
||||||
|
When the cohort is named by predicate, `provenance$scope$govids_found`
|
||||||
|
and `govids_missing` are empty -- there is no id list to report against --
|
||||||
|
and `provenance$scope$cohort` carries `state`, `type` and
|
||||||
|
`n_governments` instead. A `govid`-named cohort reports exactly as before.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
Tibble with columns `year`, `canonical_govid`, `gov_name`,
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ test_that(".build_verb_sql emits a literal category and no category filter in al
|
|||||||
sql <- uscogdata:::.build_verb_sql(
|
sql <- uscogdata:::.build_verb_sql(
|
||||||
view = "spending_annotated",
|
view = "spending_annotated",
|
||||||
subtype_col = "spend_subtype",
|
subtype_col = "spend_subtype",
|
||||||
govid = "552025209777",
|
cohort = uscogdata:::.make_cohort("552025209777"),
|
||||||
years = 2019L,
|
years = 2019L,
|
||||||
category = NULL,
|
category = NULL,
|
||||||
subtype_scope = c("operations", "capital"),
|
subtype_scope = c("operations", "capital"),
|
||||||
@@ -24,7 +24,7 @@ test_that(".build_verb_sql emits a literal category and no category filter in al
|
|||||||
test_that(".build_verb_sql is unchanged when all_categories is FALSE", {
|
test_that(".build_verb_sql is unchanged when all_categories is FALSE", {
|
||||||
args <- list(
|
args <- list(
|
||||||
view = "spending_annotated", subtype_col = "spend_subtype",
|
view = "spending_annotated", subtype_col = "spend_subtype",
|
||||||
govid = "552025209777", years = 2019L, category = NULL,
|
cohort = uscogdata:::.make_cohort("552025209777"), years = 2019L, category = NULL,
|
||||||
subtype_scope = c("operations", "capital")
|
subtype_scope = c("operations", "capital")
|
||||||
)
|
)
|
||||||
old <- do.call(uscogdata:::.build_verb_sql, args)
|
old <- do.call(uscogdata:::.build_verb_sql, args)
|
||||||
@@ -244,7 +244,7 @@ test_that('"All Categories" candidate scoping is symmetric with .build_verb_sql(
|
|||||||
con <- uscogdata:::.ensure_session()
|
con <- uscogdata:::.ensure_session()
|
||||||
|
|
||||||
none <- uscogdata:::.build_suggestions(
|
none <- uscogdata:::.build_suggestions(
|
||||||
con, govid = "010000226085", years = 2011L,
|
con, cohort = uscogdata:::.make_cohort("010000226085"), years = 2011L,
|
||||||
category = "All Categories", result = NULL, basis = "harmonized",
|
category = "All Categories", result = NULL, basis = "harmonized",
|
||||||
flow_prefixes = c("E", "F", "G"),
|
flow_prefixes = c("E", "F", "G"),
|
||||||
long_view = "spending_long_harmonized",
|
long_view = "spending_long_harmonized",
|
||||||
@@ -255,7 +255,7 @@ test_that('"All Categories" candidate scoping is symmetric with .build_verb_sql(
|
|||||||
expect_length(none, 0L)
|
expect_length(none, 0L)
|
||||||
|
|
||||||
scoped <- uscogdata:::.build_suggestions(
|
scoped <- uscogdata:::.build_suggestions(
|
||||||
con, govid = "010000226085", years = 2011L,
|
con, cohort = uscogdata:::.make_cohort("010000226085"), years = 2011L,
|
||||||
category = "All Categories", result = NULL, basis = "harmonized",
|
category = "All Categories", result = NULL, basis = "harmonized",
|
||||||
flow_prefixes = c("E", "F", "G"),
|
flow_prefixes = c("E", "F", "G"),
|
||||||
long_view = "spending_long_harmonized",
|
long_view = "spending_long_harmonized",
|
||||||
|
|||||||
@@ -0,0 +1,218 @@
|
|||||||
|
# The money verbs accepting a cohort by predicate (uscogdata#58).
|
||||||
|
#
|
||||||
|
# The load-bearing property is EQUIVALENCE: naming the same set of governments
|
||||||
|
# by id and by state/type must return the same rows. Everything else here is
|
||||||
|
# about the ways that equivalence could silently break -- the postal/FIPS
|
||||||
|
# translation, the intersection rule, and provenance no longer having an id
|
||||||
|
# list to describe.
|
||||||
|
#
|
||||||
|
# Fixture cohorts used: RI (fips 44) cities = 8 governments, DE (fips 10)
|
||||||
|
# counties = 3. Small on purpose; the size of the win is measured against the
|
||||||
|
# production corpus, not here.
|
||||||
|
|
||||||
|
# --- equivalence -----------------------------------------------------------
|
||||||
|
|
||||||
|
test_that("a predicate cohort returns exactly what the same ids return", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "RI", type = "city")$canonical_govid
|
||||||
|
expect_gt(length(ids), 1L)
|
||||||
|
|
||||||
|
by_id <- cog_spending(govid = ids, years = 2019)
|
||||||
|
by_pred <- cog_spending(years = 2019, state = "RI", type = "city")
|
||||||
|
|
||||||
|
# Compare the data itself, ignoring the provenance attribute -- which is
|
||||||
|
# SUPPOSED to differ (see the scope tests below).
|
||||||
|
expect_equal(
|
||||||
|
as.data.frame(by_id[order(by_id$canonical_govid, by_id$category), ]),
|
||||||
|
as.data.frame(by_pred[order(by_pred$canonical_govid, by_pred$category), ]),
|
||||||
|
ignore_attr = TRUE
|
||||||
|
)
|
||||||
|
expect_gt(nrow(by_pred), 0L)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("equivalence holds for cog_revenue()", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "DE", type = "county")$canonical_govid
|
||||||
|
by_id <- cog_revenue(govid = ids, years = 2019)
|
||||||
|
by_pred <- cog_revenue(years = 2019, state = "DE", type = "county")
|
||||||
|
expect_equal(nrow(by_id), nrow(by_pred))
|
||||||
|
expect_equal(sum(by_id$amt_nominal), sum(by_pred$amt_nominal))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("equivalence holds for cog_balances()", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "DE", type = "county")$canonical_govid
|
||||||
|
by_id <- cog_balances(govid = ids, years = 2019)
|
||||||
|
by_pred <- cog_balances(years = 2019, state = "DE", type = "county")
|
||||||
|
expect_equal(nrow(by_id), nrow(by_pred))
|
||||||
|
expect_equal(sum(by_id$amt_nominal), sum(by_pred$amt_nominal))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("equivalence survives per_capita, adjust_to_year and pagination", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "RI", type = "city")$canonical_govid
|
||||||
|
|
||||||
|
# per_capita now keys its population lookup on the rows in the result
|
||||||
|
# rather than on the requested cohort; these must stay identical.
|
||||||
|
by_id <- cog_spending(govid = ids, years = 2019, per_capita = TRUE,
|
||||||
|
adjust_to_year = 2020)
|
||||||
|
by_pred <- cog_spending(years = 2019, state = "RI", type = "city",
|
||||||
|
per_capita = TRUE, adjust_to_year = 2020)
|
||||||
|
expect_equal(by_id$amt_per_capita_nominal, by_pred$amt_per_capita_nominal)
|
||||||
|
expect_equal(by_id$amt_per_capita_real, by_pred$amt_per_capita_real)
|
||||||
|
expect_equal(by_id$pop_source, by_pred$pop_source)
|
||||||
|
|
||||||
|
paged_id <- cog_spending(govid = ids, years = 2019, limit = 5, offset = 5)
|
||||||
|
paged_pred <- cog_spending(years = 2019, state = "RI", type = "city",
|
||||||
|
limit = 5, offset = 5)
|
||||||
|
expect_equal(as.data.frame(paged_id), as.data.frame(paged_pred),
|
||||||
|
ignore_attr = TRUE)
|
||||||
|
expect_identical(attr(paged_id, "total_rows"), attr(paged_pred, "total_rows"))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("a state-only predicate spans every type in that state", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "DE", type = NULL)$canonical_govid
|
||||||
|
by_id <- cog_spending(govid = ids, years = 2019)
|
||||||
|
by_pred <- cog_spending(years = 2019, state = "DE")
|
||||||
|
expect_equal(nrow(by_id), nrow(by_pred))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
# --- the postal/FIPS trap --------------------------------------------------
|
||||||
|
|
||||||
|
test_that("a postal abbreviation resolves to rows, not to silence", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
# canonical_fips_xwalk.fips_state holds "44", not "RI". A predicate built
|
||||||
|
# from the raw parameter matches nothing and returns an empty result that
|
||||||
|
# reads as "these governments reported nothing" -- the exact trap cog-api
|
||||||
|
# hit. A zero-row result here is the regression.
|
||||||
|
r <- cog_spending(years = 2019, state = "RI", type = "city")
|
||||||
|
expect_gt(nrow(r), 0L)
|
||||||
|
|
||||||
|
# And the FIPS form is accepted as the same cohort.
|
||||||
|
expect_equal(nrow(cog_spending(years = 2019, state = "44", type = "city")),
|
||||||
|
nrow(r))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("an unknown state abbreviation aborts with a message that names the problem", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
# Regression: `.state_abbrev_to_fips` is a named character vector, so `[[`
|
||||||
|
# on an absent name threw base R's "subscript out of bounds" and the
|
||||||
|
# curated message was unreachable.
|
||||||
|
expect_error(cog_spending(years = 2019, state = "ZZ"),
|
||||||
|
class = "uscogdata_unknown_state")
|
||||||
|
expect_error(cog_spending(years = 2019, state = "ZZ"),
|
||||||
|
"Unknown state abbreviation")
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
# --- naming the cohort -----------------------------------------------------
|
||||||
|
|
||||||
|
test_that("naming no cohort at all is refused", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
expect_error(cog_spending(years = 2019), class = "uscogdata_no_cohort")
|
||||||
|
expect_error(cog_revenue(years = 2019), class = "uscogdata_no_cohort")
|
||||||
|
expect_error(cog_balances(years = 2019), class = "uscogdata_no_cohort")
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("an empty govid vector still fails as it always did", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
# Supplied-but-empty is a caller error, not "cohort named some other way".
|
||||||
|
expect_error(cog_spending(character(0), 2019),
|
||||||
|
"must be a non-empty character vector")
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("govid and state/type together intersect", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
cities <- cog_gov_search(NULL, state = "RI", type = "city")$canonical_govid
|
||||||
|
counties <- cog_gov_search(NULL, state = "DE", type = "county")$canonical_govid
|
||||||
|
|
||||||
|
# The documented rule: the governments in `govid` that ALSO match the
|
||||||
|
# predicate -- never one silently taking precedence over the other.
|
||||||
|
both <- cog_spending(govid = c(cities, counties), years = 2019,
|
||||||
|
state = "RI", type = "city")
|
||||||
|
only <- cog_spending(govid = cities, years = 2019)
|
||||||
|
expect_equal(as.data.frame(both), as.data.frame(only), ignore_attr = TRUE)
|
||||||
|
|
||||||
|
# A disjoint intersection is empty, not "whichever one won".
|
||||||
|
none <- cog_spending(govid = counties, years = 2019,
|
||||||
|
state = "RI", type = "city")
|
||||||
|
expect_equal(nrow(none), 0L)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
# --- provenance ------------------------------------------------------------
|
||||||
|
|
||||||
|
test_that("a govid cohort's provenance scope is untouched", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "DE", type = "county")$canonical_govid
|
||||||
|
prov <- attr(cog_spending(govid = ids, years = 2019), "provenance")
|
||||||
|
expect_setequal(prov$scope$govids_found, ids)
|
||||||
|
expect_length(prov$scope$govids_missing, 0L)
|
||||||
|
# No cohort block: govids_found already describes this cohort exactly.
|
||||||
|
expect_null(prov$scope$cohort)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("a predicate cohort describes itself instead of listing ids", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
prov <- attr(cog_spending(years = 2019, state = "DE", type = "county"),
|
||||||
|
"provenance")
|
||||||
|
# Deliberately NOT the resolved id list: a fleet-scale cohort would put
|
||||||
|
# 20,000 govids into every response body.
|
||||||
|
expect_length(prov$scope$govids_found, 0L)
|
||||||
|
expect_length(prov$scope$govids_missing, 0L)
|
||||||
|
expect_identical(prov$scope$cohort$state, "DE")
|
||||||
|
expect_identical(prov$scope$cohort$type, "county")
|
||||||
|
expect_identical(prov$scope$cohort$n_governments, 3L)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("the cohort block counts the intersection, not the predicate alone", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
counties <- cog_gov_search(NULL, state = "DE", type = "county")$canonical_govid
|
||||||
|
prov <- attr(
|
||||||
|
cog_spending(govid = counties[1], years = 2019, state = "DE", type = "county"),
|
||||||
|
"provenance"
|
||||||
|
)
|
||||||
|
expect_identical(prov$scope$cohort$n_governments, 1L)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
# --- the SQL actually changed ----------------------------------------------
|
||||||
|
|
||||||
|
test_that("a predicate cohort never renders the ids into the query", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
with_fixture_corpus({
|
||||||
|
ids <- cog_gov_search(NULL, state = "RI", type = "city")$canonical_govid
|
||||||
|
prov <- attr(cog_spending(years = 2019, state = "RI", type = "city"),
|
||||||
|
"provenance")
|
||||||
|
sql <- prov$sql_query %||% prov$sql
|
||||||
|
skip_if(is.null(sql), "provenance carries no SQL for this verb")
|
||||||
|
# The whole point: cohort size does not enter the SQL string.
|
||||||
|
for (id in ids) expect_false(grepl(id, sql, fixed = TRUE))
|
||||||
|
expect_match(sql, "SELECT canonical_govid FROM canonical_fips_xwalk",
|
||||||
|
fixed = TRUE)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
# A cohort is how every verb names the set of governments it queries. It can be
|
||||||
|
# named by explicit id, by a predicate over canonical_fips_xwalk, or by both
|
||||||
|
# (intersection). These tests cover the SQL construction itself -- pure string
|
||||||
|
# building, no corpus needed -- because that is where the postal/FIPS trap and
|
||||||
|
# the 40k-literal blowup both live.
|
||||||
|
|
||||||
|
test_that(".make_cohort() keeps an explicit id vector as ids", {
|
||||||
|
ch <- .make_cohort(govid = c("550000227544", "060000000001"))
|
||||||
|
expect_identical(ch$ids, c("550000227544", "060000000001"))
|
||||||
|
expect_null(ch$state_fips)
|
||||||
|
expect_null(ch$type_int)
|
||||||
|
expect_false(.cohort_by_predicate(ch))
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".make_cohort() translates a postal abbreviation to FIPS", {
|
||||||
|
# The trap this whole issue exists to avoid: canonical_fips_xwalk.fips_state
|
||||||
|
# holds "55", not "WI". A predicate written against the raw parameter matches
|
||||||
|
# nothing and returns an empty result that reads as "reported nothing".
|
||||||
|
ch <- .make_cohort(state = "WI")
|
||||||
|
expect_identical(ch$state_fips, "55")
|
||||||
|
expect_true(.cohort_by_predicate(ch))
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".make_cohort() translates a type label to its integer code", {
|
||||||
|
expect_identical(.make_cohort(type = "city")$type_int, 2L)
|
||||||
|
expect_identical(.make_cohort(type = "state")$type_int, 0L)
|
||||||
|
expect_identical(.make_cohort(type = 1)$type_int, 1L)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".make_cohort() reuses the search verb's coercers for invalid input", {
|
||||||
|
expect_error(.make_cohort(state = "ZZ"), "Unknown state abbreviation")
|
||||||
|
expect_error(.make_cohort(type = "special_district"), "Unknown type")
|
||||||
|
# Out-of-scope types (4 = special district, 5 = school district) are refused
|
||||||
|
# by the numeric branch, with the v0.1-scope message.
|
||||||
|
expect_error(.make_cohort(type = 4), "type must be 0, 1, 2, or 3")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".make_cohort() rejects naming no cohort at all", {
|
||||||
|
expect_error(.make_cohort(), class = "uscogdata_no_cohort")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".cohort_sql() renders an id cohort as a literal IN list", {
|
||||||
|
sql <- .cohort_sql(.make_cohort(govid = c("a", "b")))
|
||||||
|
expect_identical(sql, "canonical_govid IN ('a','b')")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".cohort_sql() renders a predicate cohort as an xwalk subquery", {
|
||||||
|
# The point of the issue: the cohort never becomes a literal list, so its
|
||||||
|
# size does not enter the SQL string at all.
|
||||||
|
sql <- .cohort_sql(.make_cohort(state = "WI", type = "city"))
|
||||||
|
expect_match(sql, "SELECT canonical_govid FROM canonical_fips_xwalk", fixed = TRUE)
|
||||||
|
expect_match(sql, "fips_state = '55'", fixed = TRUE)
|
||||||
|
expect_match(sql, "govs_type = 2", fixed = TRUE)
|
||||||
|
expect_false(grepl("'WI'", sql, fixed = TRUE))
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".cohort_sql() renders ids and a predicate as an intersection", {
|
||||||
|
sql <- .cohort_sql(.make_cohort(govid = c("a", "b"), type = "city"))
|
||||||
|
expect_match(sql, "canonical_govid IN ('a','b')", fixed = TRUE)
|
||||||
|
expect_match(sql, "AND canonical_govid IN (SELECT", fixed = TRUE)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".cohort_sql() honours a column alias", {
|
||||||
|
# Several call sites join the xwalk under an alias (`l.`, `x.`, `v.`), so the
|
||||||
|
# predicate has to be able to name the qualified column.
|
||||||
|
sql <- .cohort_sql(.make_cohort(state = "WI"), col = "l.canonical_govid")
|
||||||
|
expect_match(sql, "l.canonical_govid IN (SELECT", fixed = TRUE)
|
||||||
|
# The subquery's own column stays unqualified -- it selects from the xwalk,
|
||||||
|
# not from the outer relation.
|
||||||
|
expect_match(sql, "SELECT canonical_govid FROM", fixed = TRUE)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".cohort_sql() escapes quotes in ids", {
|
||||||
|
sql <- .cohort_sql(.make_cohort(govid = "o'brien"))
|
||||||
|
expect_match(sql, "'o''brien'", fixed = TRUE)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("a predicate cohort's SQL does not grow with cohort size", {
|
||||||
|
# The regression this guards: 20,106 ids rendered to a 301,591-character
|
||||||
|
# IN list, embedded in 5-8 statements per call.
|
||||||
|
wide <- .cohort_sql(.make_cohort(state = "CA", type = "city"))
|
||||||
|
expect_lt(nchar(wide), 200L)
|
||||||
|
})
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
# tests/testthat/test-duckdb-limits.R
|
||||||
|
#
|
||||||
|
# uscogdata#60. cog_open() used to connect with a bare dbConnect() and set no
|
||||||
|
# resource pragmas, so DuckDB claimed every visible core. That is right for one
|
||||||
|
# interactive session on a dedicated machine and wrong for a server: cog-api
|
||||||
|
# runs two replicas on an 8-core host budgeted 4, and without a cap each
|
||||||
|
# replica independently claims all 8 and they fight.
|
||||||
|
#
|
||||||
|
# The consumer-side workaround this replaces reached into the namespace at
|
||||||
|
# boot -- getFromNamespace(".ensure_session", "uscogdata")() followed by a
|
||||||
|
# manual SET threads -- which depends on a private name AND on the session
|
||||||
|
# already being open.
|
||||||
|
#
|
||||||
|
# The load-bearing property is the NEGATIVE one: unset must emit no pragma at
|
||||||
|
# all, so an unconfigured session is byte-identical to pre-#60 behaviour.
|
||||||
|
|
||||||
|
# Open a session under a given configuration and read a DuckDB setting back.
|
||||||
|
# Each call closes first, because both settings are session-scoped: an
|
||||||
|
# already-open connection would be reused by .ensure_session() and report the
|
||||||
|
# PREVIOUS test's value, which is exactly the false pass to avoid here.
|
||||||
|
setting_under <- function(setting, envvars = character(0), opts = list()) {
|
||||||
|
uscogdata:::cog_close()
|
||||||
|
on.exit(uscogdata:::cog_close(), add = TRUE)
|
||||||
|
withr::with_envvar(envvars, {
|
||||||
|
withr::with_options(opts, {
|
||||||
|
con <- uscogdata:::cog_open()
|
||||||
|
DBI::dbGetQuery(
|
||||||
|
con, sprintf("SELECT current_setting('%s') AS v", setting)
|
||||||
|
)$v[[1]]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
test_that("USCOGDATA_DUCKDB_THREADS caps the connection's thread count", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
expect_equal(
|
||||||
|
as.integer(setting_under("threads", c(USCOGDATA_DUCKDB_THREADS = "2"))),
|
||||||
|
2L
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("the option spelling works, and the env var beats it", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
expect_equal(
|
||||||
|
as.integer(setting_under("threads",
|
||||||
|
c(USCOGDATA_DUCKDB_THREADS = NA),
|
||||||
|
list(uscogdata.duckdb_threads = 3L))),
|
||||||
|
3L
|
||||||
|
)
|
||||||
|
# Same precedence .cfg() gives every other setting: env var > option.
|
||||||
|
expect_equal(
|
||||||
|
as.integer(setting_under("threads",
|
||||||
|
c(USCOGDATA_DUCKDB_THREADS = "1"),
|
||||||
|
list(uscogdata.duckdb_threads = 3L))),
|
||||||
|
1L
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("unset leaves DuckDB's own default in place", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
# Not asserting a specific number -- the default is core-count-dependent and
|
||||||
|
# a literal would fail on a different machine. The claim is that NO pragma
|
||||||
|
# was issued, so the session sees whatever DuckDB would have chosen on its
|
||||||
|
# own. Compared against a plain connection opened the pre-#60 way.
|
||||||
|
unset <- setting_under("threads",
|
||||||
|
c(USCOGDATA_DUCKDB_THREADS = NA),
|
||||||
|
list(uscogdata.duckdb_threads = NULL))
|
||||||
|
bare <- local({
|
||||||
|
con <- DBI::dbConnect(duckdb::duckdb())
|
||||||
|
on.exit(DBI::dbDisconnect(con, shutdown = TRUE), add = TRUE)
|
||||||
|
DBI::dbGetQuery(con, "SELECT current_setting('threads') AS v")$v[[1]]
|
||||||
|
})
|
||||||
|
expect_equal(as.integer(unset), as.integer(bare))
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("USCOGDATA_DUCKDB_MEMORY_LIMIT is applied", {
|
||||||
|
skip_if_no_corpus()
|
||||||
|
v <- setting_under("memory_limit", c(USCOGDATA_DUCKDB_MEMORY_LIMIT = "2GB"))
|
||||||
|
# DuckDB does not echo back the string it was given: it stores bytes and
|
||||||
|
# reports BINARY units, so "2GB" (2e9 bytes) comes back as "1.8 GiB". Assert
|
||||||
|
# the magnitude it actually means rather than the spelling this package sent
|
||||||
|
# -- matching on "2" passes for the wrong reason and fails on the right one.
|
||||||
|
expect_match(as.character(v), "GiB", fixed = TRUE)
|
||||||
|
# DuckDB also truncates the display to one decimal ("1.8 GiB" for 1.863), so
|
||||||
|
# the tolerance covers rounding, not slack in the setting itself.
|
||||||
|
gib <- as.numeric(sub("\\s*GiB$", "", as.character(v)))
|
||||||
|
expect_equal(gib, 2e9 / 1024^3, tolerance = 0.05)
|
||||||
|
})
|
||||||
|
|
||||||
|
# --- Validation -------------------------------------------------------------
|
||||||
|
# .cfg() returns an env var as CHARACTER. Without coercion here,
|
||||||
|
# sprintf("SET threads TO %d", "4") aborts inside the connection path with an
|
||||||
|
# error about the pragma rather than about the setting the operator got wrong.
|
||||||
|
|
||||||
|
test_that(".resolve_duckdb_threads coerces a character env var to integer", {
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_THREADS = "4")
|
||||||
|
expect_identical(uscogdata:::.resolve_duckdb_threads(), 4L)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".resolve_duckdb_threads returns NULL when unset or empty", {
|
||||||
|
withr::local_options(uscogdata.duckdb_threads = NULL)
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_THREADS = NA)
|
||||||
|
expect_null(uscogdata:::.resolve_duckdb_threads())
|
||||||
|
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_THREADS = "")
|
||||||
|
expect_null(uscogdata:::.resolve_duckdb_threads())
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".resolve_duckdb_threads rejects values that are not positive integers", {
|
||||||
|
for (bad in c("0", "-1", "two", "1.5.2")) {
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_THREADS = bad)
|
||||||
|
expect_error(uscogdata:::.resolve_duckdb_threads(),
|
||||||
|
class = "uscogdata_invalid_duckdb_threads")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".resolve_duckdb_memory_limit accepts size strings and rejects junk", {
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_MEMORY_LIMIT = "4GB")
|
||||||
|
expect_identical(uscogdata:::.resolve_duckdb_memory_limit(), "4GB")
|
||||||
|
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_MEMORY_LIMIT = "1.5GB")
|
||||||
|
expect_identical(uscogdata:::.resolve_duckdb_memory_limit(), "1.5GB")
|
||||||
|
|
||||||
|
# A SQL fragment must not reach the connection as one.
|
||||||
|
withr::local_envvar(USCOGDATA_DUCKDB_MEMORY_LIMIT = "4GB'; DROP TABLE x; --")
|
||||||
|
expect_error(uscogdata:::.resolve_duckdb_memory_limit(),
|
||||||
|
class = "uscogdata_invalid_duckdb_memory_limit")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that(".apply_duckdb_limits issues no statement when both are NULL", {
|
||||||
|
# The negative property, asserted directly rather than inferred: a connection
|
||||||
|
# that would ERROR on any statement proves none was sent.
|
||||||
|
expect_silent(uscogdata:::.apply_duckdb_limits(NULL, NULL, NULL))
|
||||||
|
})
|
||||||
@@ -62,3 +62,36 @@ test_that("registered `long` view reads through the enumerated list", {
|
|||||||
expect_true(all(c(2011, 2012, 2019, 2020) %in% yrs))
|
expect_true(all(c(2011, 2012, 2019, 2020) %in% yrs))
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
test_that("a Windows-style corpus path survives token substitution", {
|
||||||
|
# gsub() in regex mode treats backslashes in the REPLACEMENT as escape
|
||||||
|
# sequences and silently drops them, so a Windows path went in as
|
||||||
|
# C:\Users\RUNNER\... and came out as C:UsersRUNNER..., after which every
|
||||||
|
# DuckDB read failed with "No files found that match the pattern".
|
||||||
|
#
|
||||||
|
# That made a LOCAL corpus unreadable on Windows -- the bundled fixture
|
||||||
|
# included, so the whole suite failed there -- while remote https URLs
|
||||||
|
# worked fine, having no backslashes. It went unnoticed for the life of the
|
||||||
|
# package because nothing ever ran on Windows.
|
||||||
|
#
|
||||||
|
# Reproducible on any platform: this is string handling, not a filesystem
|
||||||
|
# behaviour, so it does not need a Windows runner to catch.
|
||||||
|
win <- "C:\\Users\\RUNNER~1\\AppData\\Local\\Temp\\Rtmp123/"
|
||||||
|
|
||||||
|
out <- uscogdata:::.render_view_sql(
|
||||||
|
"FROM read_parquet('{url}data/summary_categories.parquet')", win
|
||||||
|
)
|
||||||
|
expect_true(grepl("C:\\Users\\RUNNER~1\\AppData", out, fixed = TRUE))
|
||||||
|
expect_false(grepl("C:Users", out, fixed = TRUE))
|
||||||
|
|
||||||
|
# The same must hold through the {long_files} path, which embeds the url
|
||||||
|
# once per enumerated partition.
|
||||||
|
manifest <- list(files = list(long_partitions = list(
|
||||||
|
list(year = 2011L, path = "data/long/year=2011/part-0.parquet")
|
||||||
|
)))
|
||||||
|
out2 <- uscogdata:::.render_view_sql(
|
||||||
|
"FROM read_parquet({long_files}, hive_partitioning = true)", win, manifest
|
||||||
|
)
|
||||||
|
expect_true(grepl("C:\\Users\\RUNNER~1\\AppData", out2, fixed = TRUE))
|
||||||
|
expect_false(grepl("C:Users", out2, fixed = TRUE))
|
||||||
|
})
|
||||||
|
|||||||
@@ -251,7 +251,7 @@ test_that(".suppressed_components measures the E67/E68 dollars Public Welfare dr
|
|||||||
s <- uscogdata:::.suppressed_components(
|
s <- uscogdata:::.suppressed_components(
|
||||||
con,
|
con,
|
||||||
candidates = c("welfare_cash_e67_wide", "welfare_cash_e68_wide"),
|
candidates = c("welfare_cash_e67_wide", "welfare_cash_e68_wide"),
|
||||||
govid = "061037123085", years = 2011L,
|
cohort = uscogdata:::.make_cohort("061037123085"), years = 2011L,
|
||||||
long_view = "spending_long_harmonized",
|
long_view = "spending_long_harmonized",
|
||||||
flow_prefixes = c("E", "F", "G"))
|
flow_prefixes = c("E", "F", "G"))
|
||||||
|
|
||||||
@@ -269,7 +269,7 @@ test_that(".suppressed_components finds nothing in a modern year", {
|
|||||||
s <- uscogdata:::.suppressed_components(
|
s <- uscogdata:::.suppressed_components(
|
||||||
con,
|
con,
|
||||||
candidates = c("welfare_cash_e67_wide", "welfare_cash_e68_wide"),
|
candidates = c("welfare_cash_e67_wide", "welfare_cash_e68_wide"),
|
||||||
govid = "061037123085", years = 2019L,
|
cohort = uscogdata:::.make_cohort("061037123085"), years = 2019L,
|
||||||
long_view = "spending_long_harmonized",
|
long_view = "spending_long_harmonized",
|
||||||
flow_prefixes = c("E", "F", "G"))
|
flow_prefixes = c("E", "F", "G"))
|
||||||
expect_equal(nrow(s), 0L)
|
expect_equal(nrow(s), 0L)
|
||||||
@@ -280,7 +280,7 @@ test_that(".suppressed_components rejects a long_view outside the allowlist", {
|
|||||||
con <- uscogdata:::.ensure_session()
|
con <- uscogdata:::.ensure_session()
|
||||||
expect_error(
|
expect_error(
|
||||||
uscogdata:::.suppressed_components(
|
uscogdata:::.suppressed_components(
|
||||||
con, candidates = "welfare_cash_e67_wide", govid = "061037123085",
|
con, candidates = "welfare_cash_e67_wide", cohort = uscogdata:::.make_cohort("061037123085"),
|
||||||
years = 2011L, long_view = "long; DROP TABLE x",
|
years = 2011L, long_view = "long; DROP TABLE x",
|
||||||
flow_prefixes = c("E", "F", "G")),
|
flow_prefixes = c("E", "F", "G")),
|
||||||
class = "uscogdata_internal_error")
|
class = "uscogdata_internal_error")
|
||||||
@@ -298,7 +298,7 @@ test_that(".suppressed_components never measures a component from the other flow
|
|||||||
s <- uscogdata:::.suppressed_components(
|
s <- uscogdata:::.suppressed_components(
|
||||||
con,
|
con,
|
||||||
candidates = c("welfare_cash_e67_wide", "welfare_cash_e68_wide"),
|
candidates = c("welfare_cash_e67_wide", "welfare_cash_e68_wide"),
|
||||||
govid = "061037123085", years = 2011L,
|
cohort = uscogdata:::.make_cohort("061037123085"), years = 2011L,
|
||||||
long_view = "revenue_long_harmonized",
|
long_view = "revenue_long_harmonized",
|
||||||
flow_prefixes = c("T", "A", "U", "B", "C", "D"))
|
flow_prefixes = c("T", "A", "U", "B", "C", "D"))
|
||||||
expect_equal(nrow(s), 0L)
|
expect_equal(nrow(s), 0L)
|
||||||
|
|||||||
Reference in New Issue
Block a user