Files
uscogdata/docs/pm/STATUS.md
T
Jared Knowles 2e317d3a0f
Mirror to GitHub / mirror (push) Successful in 10s
R-CMD-check / check (push) Successful in 3m55s
chore: adopt compass for project tracking
Three workstreams -- the query verbs, the corpus and how it is mounted, and the
docs that explain both. Each can go stale independently, which is what the
workstream boundary is for: a change to a verb obligates the vignettes, a change
to the corpus obligates NEWS.

All six open issues now carry ws/ and type/ labels, applied additively so #36
kept its existing kodor/, severity/, south-guide and verdict/ labels. The
generated board is pinned as issue #68.

.roborev.toml carries review guidelines composed from a shared baseline, the R
package overlay, and this project's own conventions read out of CLAUDE.md: the
ensure_session-then-dbGetQuery order, the tbl_df-with-provenance return
contract, coerce_govid_input at the boundary, the two SQL layers, no arrow, and
withr as tests-only.

The .gitignore change is load-bearing. pkgdown output made docs/ ignored, which
would have left every compass file untracked and unable to travel to another
machine. Git cannot re-include anything beneath an excluded directory, so the
rule had to list children instead. That forced an anchoring change: a bare
"docs/" matches at any depth, "/docs/*" only at the root, so the fixture corpus
docs directory needed an explicit rule to stay excluded as before.
2026-08-23 16:17:20 -04:00

3.1 KiB

Project status

Between the compass markers is generated. Edit the sources, not this.

Where this stands

uscogdata is at 0.4.0 and its public surface is settled: the query verbs, the cohort predicates added in this release, and the provenance contract every verb returns.

The six open issues split cleanly. Two are API work carried out of the #9 review pass and deliberately deferred there rather than fixed in that branch. Three concern the corpus layer, and the largest of them, partition-level caching, was named the single highest-leverage change on the remote path before being deferred. One, the data-correction intake, is a decision rather than a task: it was parked during the 0.3.0 design and it gates the API announcement, because without it the corpus cannot make the "traceable and correctable" claim that most distinguishes it from Census's own files.

Nothing here is blocked on anything else, so the ordering is a judgement about value rather than a dependency graph.

Ready to work on next

  • #34 cog_revenue() offers expenditure recipes as suggestions: scope the candidate query by category_type · ws/api — nothing is blocking it; something is currently wrong
  • #36 n_units_reporting is category-conditional and cannot be read as a response rate · ws/corpus — nothing is blocking it; owed work from an earlier change
  • #2 Extend population data to be households as an alternate spending denominator · ws/corpus — nothing is blocking it
  • #33 Decompose .build_suggestions() (106 lines) into named helpers · ws/api — nothing is blocking it
  • #52 Release 11/11: design the data-correction intake (deferred; gates the API announcement) · ws/corpus — nothing is blocking it
  • #64 Partition-level caching: R/cache.R is still a stub, and the remote path pays for it every session · ws/corpus — nothing is blocking it

Workstreams

Stream Commits since Open Debt Owes docs
Query verbs and results 77 2 0 no
Corpus, mirror, provenance 39 4 1 no
Vignettes and guides 34 0 0 yes

CI

R-CMD-check Mirror to GitHub

Dependency graph and detail
graph TD
  I34["#34 cog_revenue() offers expenditure recipes as sug…"]
  I36["#36 n_units_reporting is category-conditional and c…"]
  I2["#2 Extend population data to be households as an a…"]
  I33["#33 Decompose .build_suggestions() (106 lines) into…"]
  I52["#52 Release 11/11: design the data-correction intak…"]
  I64["#64 Partition-level caching: R/cache.R is still a s…"]
  class I34 ready;
  class I36 ready;
  class I2 ready;
  class I33 ready;
  class I52 ready;
  class I64 ready;
  classDef ready fill:#dafbe1,stroke:#2da44e;
  • Marker: none (no journal entry yet)
  • Commits since: 164
  • Open issues: 6