Nason commited on
Commit
0e5aa14
·
verified ·
1 Parent(s): b40e258

Record live datapond catalog integration and consumer verification

Browse files
Files changed (1) hide show
  1. README.md +8 -8
README.md CHANGED
@@ -20,7 +20,7 @@ A pinned DuckDB edition of NHTSA's [Fatality Analysis Reporting System](https://
20
 
21
  This is the **first 2024 ARF, released April 1, 2026**, not the later final file. Coverage is the 50 states and the District of Columbia; Puerto Rico is a separate archive and is not included.
22
 
23
- Built with [fars-database](https://github.com/ian-nason/fars-database). Published to Hugging Face on 2026-10-18. The datapond registry entry is a draft pull request, so `datapond.connect('fars')` does not resolve this database until it is merged; the direct URL below works now.
24
 
25
  [Quick start](#quick-start) · [Tables](#tables) · [Views](#pre-built-views) · [Examples](#example-queries) · [Caveats](#researcher-caveats) · [Source](#data-source-and-version) · [License](#license-and-attribution) · [Changelog](#changelog)
26
 
@@ -77,9 +77,9 @@ dbDisconnect(con, shutdown = TRUE)
77
 
78
  In the tested R DuckDB 1.5.5 configuration, BIGINT and DECIMAL results are exposed as doubles. Counts here are exact; coordinates and `measured_bac_g_dl` may be approximate in R although the stored DECIMAL values are exact.
79
 
80
- ### datapond package (after catalog integration)
81
 
82
- The public default catalog does not yet include `fars`. After its registry entry is merged, these examples use the package's normal discovery and connection API:
83
 
84
  ```python
85
  import datapond
@@ -99,7 +99,7 @@ DBI::dbGetQuery(con, "SELECT count(*) AS fatal_crashes, sum(fatals) AS fatalitie
99
  dp_disconnect(con)
100
  ```
101
 
102
- For repeated scans, after catalog integration, download once and connect locally:
103
 
104
  ```python
105
  import datapond
@@ -119,7 +119,7 @@ dp_disconnect(con)
119
 
120
  Verify the recorded artifact SHA-256 after downloading. In tested Python 0.1.1, the optional Hugging Face download path follows the default branch rather than the pinned URL; see [consumer verification](https://github.com/ian-nason/fars-database/blob/main/docs/CONSUMERS.md) for the tested configuration.
121
 
122
- Package checks use an isolated candidate registry; default-catalog discovery remains pending. See [consumer verification](https://github.com/ian-nason/fars-database/blob/main/docs/CONSUMERS.md) for exact client versions, paths, resource limits and download behavior. The direct URL examples above work independently of the catalog. The SQL examples below use the `fars` catalog alias from the direct-URL quick start.
123
 
124
 
125
  ## Tables
@@ -207,17 +207,17 @@ Redistribution rests on NHTSA's own [Ownership policy](https://www.nhtsa.gov/abo
207
 
208
  - Source, build scripts, tests and evidence: [github.com/ian-nason/fars-database](https://github.com/ian-nason/fars-database)
209
  - Column dictionary (all 413 columns with original headers, definitions and manual PDF pages): [DICTIONARY.md](https://github.com/ian-nason/fars-database/blob/main/DICTIONARY.md)
210
- - Catalog: [datapond registry](https://github.com/datapond-db/registry); the entry for `fars` is a draft pull request and the database will appear on the [datapond website](https://datapond-db.github.io/website/) once it is merged.
211
 
212
  ## Changelog
213
 
214
  ### 2026-10-18 — Documentation refresh
215
 
216
  - Added Python/R quick starts, table descriptions and column counts, view guidance, navigation, and clearer researcher caveats.
217
- - Database bytes, schema, source locks and validated query results are unchanged. Catalog integration remains pending.
218
 
219
  ### 2026-10-18 — Initial release
220
 
221
  - FARS 2024 ARF (first release): 190,798 rows across 4 tables (413 columns) and 3 views; 36,297 crashes, 39,254 fatalities. Artifact 26,488,832 bytes, SHA-256 `2bc31f9e…fc7442`, commit `adb6da02`.
222
  - Every typed cell verified against an independent read of the pinned source ZIP; per-crash count and fatality reconciliation; public immutable URL, HTTP range requests and the installed Python and R clients tested after upload.
223
- - Registry entry opened as a draft pull request; catalog integration pending.
 
20
 
21
  This is the **first 2024 ARF, released April 1, 2026**, not the later final file. Coverage is the 50 states and the District of Columbia; Puerto Rico is a separate archive and is not included.
22
 
23
+ Built with [fars-database](https://github.com/ian-nason/fars-database). Published to Hugging Face on 2026-10-18. The dataset is included in the public datapond catalog as `fars`. Use normal package discovery and connections, or the immutable direct URL below.
24
 
25
  [Quick start](#quick-start) · [Tables](#tables) · [Views](#pre-built-views) · [Examples](#example-queries) · [Caveats](#researcher-caveats) · [Source](#data-source-and-version) · [License](#license-and-attribution) · [Changelog](#changelog)
26
 
 
77
 
78
  In the tested R DuckDB 1.5.5 configuration, BIGINT and DECIMAL results are exposed as doubles. Counts here are exact; coordinates and `measured_bac_g_dl` may be approximate in R although the stored DECIMAL values are exact.
79
 
80
+ ### datapond package
81
 
82
+ These examples use the public default catalog and the package's normal discovery and connection API:
83
 
84
  ```python
85
  import datapond
 
99
  dp_disconnect(con)
100
  ```
101
 
102
+ For repeated scans, download once and connect locally:
103
 
104
  ```python
105
  import datapond
 
119
 
120
  Verify the recorded artifact SHA-256 after downloading. In tested Python 0.1.1, the optional Hugging Face download path follows the default branch rather than the pinned URL; see [consumer verification](https://github.com/ian-nason/fars-database/blob/main/docs/CONSUMERS.md) for the tested configuration.
121
 
122
+ Default-catalog discovery and representative remote queries were verified after the registry merge. Earlier full-download checks used an isolated candidate registry. See [consumer verification](https://github.com/ian-nason/fars-database/blob/main/docs/CONSUMERS.md) for exact client versions, paths, resource limits and download behavior. The direct URL examples above work independently of the catalog. The SQL examples below use the `fars` catalog alias from the direct-URL quick start.
123
 
124
 
125
  ## Tables
 
207
 
208
  - Source, build scripts, tests and evidence: [github.com/ian-nason/fars-database](https://github.com/ian-nason/fars-database)
209
  - Column dictionary (all 413 columns with original headers, definitions and manual PDF pages): [DICTIONARY.md](https://github.com/ian-nason/fars-database/blob/main/DICTIONARY.md)
210
+ - Catalog: [datapond registry](https://github.com/datapond-db/registry); `fars` is included in the public catalog and on the [datapond website](https://datapond-db.github.io/website/).
211
 
212
  ## Changelog
213
 
214
  ### 2026-10-18 — Documentation refresh
215
 
216
  - Added Python/R quick starts, table descriptions and column counts, view guidance, navigation, and clearer researcher caveats.
217
+ - Database bytes, schema, source locks and validated query results are unchanged. Catalog integration was pending at this documentation checkpoint; it is now complete.
218
 
219
  ### 2026-10-18 — Initial release
220
 
221
  - FARS 2024 ARF (first release): 190,798 rows across 4 tables (413 columns) and 3 views; 36,297 crashes, 39,254 fatalities. Artifact 26,488,832 bytes, SHA-256 `2bc31f9e…fc7442`, commit `adb6da02`.
222
  - Every typed cell verified against an independent read of the pinned source ZIP; per-crash count and fatality reconciliation; public immutable URL, HTTP range requests and the installed Python and R clients tested after upload.
223
+ - Registry entry initially opened as a draft pull request; later merged after integration review.