Civilytics/uscogdata
3
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

feat(rollup): drop unavailable-pop rows + provenance audit

Browse Source 
cog_geographic_rollup(per_capita = TRUE) now drops rows whose government
has no observed population for that year (pop_source == 'unavailable'),
matching the spec's exclusion rule. Records included/excluded govids in
provenance$rollup.
This commit is contained in:
jared
2026-04-29 17:50:59 -04:00
parent c334be7706
commit b7ebb4cd88
2 changed files with 42 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/cog_geographic_rollup.Rd
+15 -5
View File
@@ -22,17 +22,19 @@ to [cog_spending()]).}
\item{years}{Integer vector of years.}
\item{per_capita}{If `TRUE`, per-capita uses each layer's own population
from `canonical_fips_xwalk.population_acs`.}
\item{per_capita}{If `TRUE`, per-capita uses each gov's own per-year
population from `gov_population_yearly`. Govs with missing population
are excluded from the result.}
\item{adjust_to_year}{Integer base year for CPI-U conversion, or `NULL`.}
}
\value{
Tibble with columns `year`, `layer`, `canonical_govid`, `gov_name`,
`spend_subtype`, `category`, `amt_nominal`, optional `amt_real` /
`amt_per_capita_nominal` / `amt_per_capita_real`, `codes_included`,
`aggregate_fallback`, `scope_note`, `notes`. Carries a `provenance`
attribute with `verb = "cog_geographic_rollup"` and `layers`.
`amt_per_capita_nominal` / `amt_per_capita_real`, optional `pop_source`,
`codes_included`, `aggregate_fallback`, `scope_note`, `notes`. Carries a
`provenance` attribute with `verb = "cog_geographic_rollup"`, `layers`,
and `rollup$included_govids` / `rollup$excluded_govids`.
}
\description{
Wraps [cog_spending()], tags each row with its layer, and attaches a
@@ -41,3 +43,11 @@ human-readable `scope_note` documenting geographic-scope caveats (e.g.
"place portraits" that compare a city to the surrounding county and
containing state on one set of axes.
}
\details{
When `per_capita = TRUE`, rows whose government has no observed
population in that year (`pop_source == "unavailable"`) are dropped from
the result. The dropped govids are recorded in
`provenance$rollup$excluded_govids`. This excludes special districts
(gov type 4) and school districts (gov type 5) from per-capita rollups
by design — see `vignette('population-denominators')`.
}