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

docs: add a vignette explaining provenance$coverage counters #72

New Issue
Open
opened 2026-09-09 13:38:00 -04:00 by jared · 0 comments
jared commented 2026-09-09 13:38:00 -04:00
Owner
Copy Link
Copy Source

Neither vignette (population-denominators.Rmd, total-spending.Rmd) covers provenance$coverage, though cog_geographic_rollup() and cog_peer_compare() both carry it and #36 made reading it correctly a three-way distinction, not two.

A short walkthrough -- what each counter answers, the FY2012 Georgia Police example already in the roxygen/README, and the two derived ratios -- would give this the same treatment total-spending.Rmd gives basic aggregation.

Filed by compass:wrap: the "corpus" and "docs" workstreams both moved without a matching documentation update this session.

Neither vignette (`population-denominators.Rmd`, `total-spending.Rmd`) covers `provenance$coverage`, though `cog_geographic_rollup()` and `cog_peer_compare()` both carry it and #36 made reading it correctly a three-way distinction, not two. A short walkthrough -- what each counter answers, the FY2012 Georgia Police example already in the roxygen/README, and the two derived ratios -- would give this the same treatment `total-spending.Rmd` gives basic aggregation. Filed by compass:wrap: the "corpus" and "docs" workstreams both moved without a matching documentation update this session.
jared added the
ws
docs
type
debt
origin
obligation
 labels 2026-09-09 13:38:00 -04:00
jared referenced this issue from a commit 2026-09-09 13:38:27 -04:00
docs: record session (#36)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
kodor
Kodor should process this issue
 kodor/feature-proposal
Kodor has written a feature proposal
 kodor/fix
Kodor should implement a fix (assigned to Kodor)
 kodor/needs-review
Kodor's work or failure needs Jared's review
 kodor/triaged
Kodor has already triaged this issue (skip)
 madison-walkthrough
severity/high
severity/low
severity/medium
south-guide
Surfaced while building the client-facing Southern API guide
 verdict/defect
verdict/definitional
needs
human
Cannot move without a person -- a decision, a check an agent cannot make, something outside the repo
origin
client
Came from a client ask
origin
obligation
Created by a change elsewhere
origin
review
Came from human review
origin
roborev
Promoted from a roborev finding
type
chore
Maintenance with no behaviour change
type
debt
Owed work -- docs, tests, cleanup a change obligated
type
decision
Needs a decision before work can proceed
type
defect
Something is wrong
type
feature
New capability
ws
api
Query verbs and results
ws
corpus
Corpus, mirror, provenance
ws
docs
Vignettes and guides
kodor
Assign a task to kodor
 kodor/feature-proposal
Kodor thinks this needs a feature.
 kodor/fix
Kodor should fix this
 kodor/needs-review
Kodor thinks the user is ready to review this.
 kodor/triaged
Kodor is done with this issue.
No labels
origin
obligation
type
debt
ws
docs
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
hannah (Hannah Miller) jared (Jared Knowles) kodor
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Civilytics/uscogdata#72