data-analyst-mcp 0.3.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -6
- package/dist/adapters/_census_micro.js +2 -2
- package/dist/adapters/_census_micro.js.map +1 -1
- package/dist/adapters/bjs.d.ts +13 -0
- package/dist/adapters/bjs.js +28 -0
- package/dist/adapters/bjs.js.map +1 -0
- package/dist/adapters/cbp.d.ts +5 -0
- package/dist/adapters/cbp.js +64 -0
- package/dist/adapters/cbp.js.map +1 -0
- package/dist/adapters/cdc-wonder.d.ts +5 -0
- package/dist/adapters/cdc-wonder.js +68 -0
- package/dist/adapters/cdc-wonder.js.map +1 -0
- package/dist/adapters/cpsc.d.ts +4 -0
- package/dist/adapters/cpsc.js +125 -0
- package/dist/adapters/cpsc.js.map +1 -0
- package/dist/adapters/fhwa.d.ts +9 -0
- package/dist/adapters/fhwa.js +16 -0
- package/dist/adapters/fhwa.js.map +1 -0
- package/dist/adapters/foreign-assistance.d.ts +9 -0
- package/dist/adapters/foreign-assistance.js +42 -0
- package/dist/adapters/foreign-assistance.js.map +1 -0
- package/dist/adapters/hud-ahar.d.ts +3 -0
- package/dist/adapters/hud-ahar.js +80 -0
- package/dist/adapters/hud-ahar.js.map +1 -0
- package/dist/adapters/nces.d.ts +10 -0
- package/dist/adapters/nces.js +32 -0
- package/dist/adapters/nces.js.map +1 -0
- package/dist/adapters/nsf.d.ts +11 -0
- package/dist/adapters/nsf.js +25 -0
- package/dist/adapters/nsf.js.map +1 -0
- package/dist/adapters/onrr.d.ts +9 -0
- package/dist/adapters/onrr.js +35 -0
- package/dist/adapters/onrr.js.map +1 -0
- package/dist/adapters/sba.d.ts +10 -0
- package/dist/adapters/sba.js +134 -0
- package/dist/adapters/sba.js.map +1 -0
- package/dist/adapters/treasury-tic.d.ts +30 -0
- package/dist/adapters/treasury-tic.js +149 -0
- package/dist/adapters/treasury-tic.js.map +1 -0
- package/dist/adapters/uscourts.d.ts +8 -0
- package/dist/adapters/uscourts.js +8 -0
- package/dist/adapters/uscourts.js.map +1 -0
- package/dist/analysis/cite.d.ts +9 -1
- package/dist/analysis/cite.js +9 -2
- package/dist/analysis/cite.js.map +1 -1
- package/dist/analysis/compute.d.ts +22 -10
- package/dist/analysis/compute.js +75 -16
- package/dist/analysis/compute.js.map +1 -1
- package/dist/analysis/expr.d.ts +2 -0
- package/dist/analysis/expr.js +17 -0
- package/dist/analysis/expr.js.map +1 -1
- package/dist/analysis/replicate.d.ts +15 -0
- package/dist/analysis/replicate.js +228 -0
- package/dist/analysis/replicate.js.map +1 -0
- package/dist/analysis/rerun.js +2 -1
- package/dist/analysis/rerun.js.map +1 -1
- package/dist/analysis/table.d.ts +14 -0
- package/dist/analysis/table.js +79 -28
- package/dist/analysis/table.js.map +1 -1
- package/dist/analysis/tools.js +16 -4
- package/dist/analysis/tools.js.map +1 -1
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +17 -0
- package/dist/bin/cli.js.map +1 -1
- package/dist/core/generic-rest.js +42 -17
- package/dist/core/generic-rest.js.map +1 -1
- package/dist/core/guard.d.ts +32 -0
- package/dist/core/guard.js +176 -0
- package/dist/core/guard.js.map +1 -0
- package/dist/core/http.d.ts +10 -0
- package/dist/core/http.js +36 -7
- package/dist/core/http.js.map +1 -1
- package/dist/core/keys.d.ts +13 -3
- package/dist/core/keys.js +67 -7
- package/dist/core/keys.js.map +1 -1
- package/dist/core/package.d.ts +12 -3
- package/dist/core/package.js +56 -12
- package/dist/core/package.js.map +1 -1
- package/dist/core/packs.d.ts +14 -5
- package/dist/core/packs.js.map +1 -1
- package/dist/{deep/_opm_parquet.d.ts → core/parquet.d.ts} +2 -1
- package/dist/{deep/_opm_parquet.js → core/parquet.js} +7 -5
- package/dist/core/parquet.js.map +1 -0
- package/dist/core/secret_patterns.d.ts +6 -0
- package/dist/core/secret_patterns.js +20 -0
- package/dist/core/secret_patterns.js.map +1 -0
- package/dist/core/tabular.d.ts +43 -1
- package/dist/core/tabular.js +149 -6
- package/dist/core/tabular.js.map +1 -1
- package/dist/deep/_opm_io.js +2 -2
- package/dist/deep/_opm_io.js.map +1 -1
- package/dist/deep/bea.js +1 -0
- package/dist/deep/bea.js.map +1 -1
- package/dist/deep/fred.js +40 -9
- package/dist/deep/fred.js.map +1 -1
- package/dist/deep/ipums.js +1 -0
- package/dist/deep/ipums.js.map +1 -1
- package/dist/deep/opm.js +1 -1
- package/dist/deep/opm.js.map +1 -1
- package/dist/envelope.js +3 -1
- package/dist/envelope.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.js +45 -46
- package/dist/index.js.map +1 -1
- package/dist/remote/app.js +87 -31
- package/dist/remote/app.js.map +1 -1
- package/dist/remote/oauth.js +8 -1
- package/dist/remote/oauth.js.map +1 -1
- package/dist/remote/pages.d.ts +3 -7
- package/dist/remote/pages.js +49 -19
- package/dist/remote/pages.js.map +1 -1
- package/dist/remote/sign.d.ts +7 -1
- package/dist/remote/sign.js +33 -7
- package/dist/remote/sign.js.map +1 -1
- package/dist/remote/store.js +14 -5
- package/dist/remote/store.js.map +1 -1
- package/dist/report/audit_report.js +29 -7
- package/dist/report/audit_report.js.map +1 -1
- package/dist/report/build_report.js +34 -4
- package/dist/report/build_report.js.map +1 -1
- package/dist/report/method_audit.js +3 -0
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.js +2 -13
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/report/tools.js +2 -1
- package/dist/report/tools.js.map +1 -1
- package/dist/server.d.ts +3 -1
- package/dist/server.js +53 -17
- package/dist/server.js.map +1 -1
- package/dist/tools.d.ts +3 -1
- package/dist/tools.js +82 -9
- package/dist/tools.js.map +1 -1
- package/guide/WORKFLOW.md +6 -5
- package/guide/assets/download_data.ps1 +2 -0
- package/guide/assets/download_data.sh +8 -2
- package/guide/references/report_patterns.md +5 -2
- package/guide/references/report_schema.md +140 -0
- package/guide/references/routing.md +30 -3
- package/package.json +1 -1
- package/packs/bjs/endpoints.json +150 -0
- package/packs/bjs/policy.json +114 -0
- package/packs/bjs/source.md +98 -0
- package/packs/cbp/endpoints.json +31 -0
- package/packs/cbp/policy.json +85 -0
- package/packs/cbp/source.md +57 -0
- package/packs/cdc/source.md +1 -1
- package/packs/cdc-wonder/endpoints.json +26 -0
- package/packs/cdc-wonder/policy.json +84 -0
- package/packs/cdc-wonder/source.md +53 -0
- package/packs/census/source.md +8 -4
- package/packs/college-scorecard/source.md +1 -1
- package/packs/cpsc/endpoints.json +91 -0
- package/packs/cpsc/policy.json +91 -0
- package/packs/cpsc/source.md +76 -0
- package/packs/dhs-ohss/source.md +1 -1
- package/packs/doj-news/source.md +1 -1
- package/packs/fbi/source.md +3 -3
- package/packs/fhwa/endpoints.json +48 -0
- package/packs/fhwa/policy.json +91 -0
- package/packs/fhwa/source.md +59 -0
- package/packs/foreign-assistance/endpoints.json +166 -0
- package/packs/foreign-assistance/policy.json +80 -0
- package/packs/foreign-assistance/source.md +76 -0
- package/packs/fred/source.md +2 -1
- package/packs/fsa/source.md +1 -1
- package/packs/hud/source.md +1 -1
- package/packs/hud-ahar/endpoints.json +92 -0
- package/packs/hud-ahar/policy.json +88 -0
- package/packs/hud-ahar/source.md +72 -0
- package/packs/ipums/docs/report_patterns.md +1 -1
- package/packs/ipums/docs/variables.md +4 -3
- package/packs/ipums/source.md +10 -8
- package/packs/naep/source.md +1 -1
- package/packs/nces/endpoints.json +101 -0
- package/packs/nces/policy.json +99 -0
- package/packs/nces/source.md +75 -0
- package/packs/nhtsa/source.md +1 -1
- package/packs/nsf/endpoints.json +33 -0
- package/packs/nsf/policy.json +83 -0
- package/packs/nsf/source.md +59 -0
- package/packs/onrr/endpoints.json +198 -0
- package/packs/onrr/policy.json +91 -0
- package/packs/onrr/source.md +55 -0
- package/packs/opm/docs/opm_api.md +2 -1
- package/packs/opm/source.md +2 -1
- package/packs/port.json +65 -0
- package/packs/sba/endpoints.json +34 -0
- package/packs/sba/policy.json +86 -0
- package/packs/sba/source.md +60 -0
- package/packs/treasury/source.md +1 -1
- package/packs/treasury-tic/endpoints.json +77 -0
- package/packs/treasury-tic/policy.json +89 -0
- package/packs/treasury-tic/source.md +80 -0
- package/packs/uscourts/endpoints.json +22 -0
- package/packs/uscourts/policy.json +87 -0
- package/packs/uscourts/source.md +56 -0
- package/packs/uspto/source.md +1 -1
- package/dist/deep/_opm_parquet.js.map +0 -1
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://api.ojp.gov/bjsdataset/v1",
|
|
3
|
+
"timeout": 90,
|
|
4
|
+
"endpoints": {
|
|
5
|
+
"query": {
|
|
6
|
+
"path": "/{dataset}.json",
|
|
7
|
+
"method": "GET",
|
|
8
|
+
"description": "NCVS Select records from BJS's API (one row per victimization, person or household, 1993 on, with weights): filter with $where and pick columns with $select. Aggregate SoQL (sum, count, $group) is refused by the site's bot check: aggregate the rows with compute.",
|
|
9
|
+
"params": {
|
|
10
|
+
"dataset": {
|
|
11
|
+
"in": "path",
|
|
12
|
+
"required": true,
|
|
13
|
+
"catalog": true,
|
|
14
|
+
"desc": "personal_victimization, personal_population, household_victimization, household_population (or the 4x4 id)"
|
|
15
|
+
},
|
|
16
|
+
"$select": {
|
|
17
|
+
"desc": "plain columns only, comma-separated: year, newcrime, newoff, newwgt"
|
|
18
|
+
},
|
|
19
|
+
"$where": {
|
|
20
|
+
"desc": "SoQL filter; every column is text, so quote values: year = '2024' AND newcrime = '1'"
|
|
21
|
+
},
|
|
22
|
+
"$order": {
|
|
23
|
+
"desc": "SoQL order; default :id gives stable paging"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"defaults": {
|
|
27
|
+
"$order": ":id"
|
|
28
|
+
},
|
|
29
|
+
"records": "",
|
|
30
|
+
"paging": {
|
|
31
|
+
"type": "offset",
|
|
32
|
+
"limit_param": "$limit",
|
|
33
|
+
"offset_param": "$offset",
|
|
34
|
+
"size": 50000,
|
|
35
|
+
"manual_size": 50000
|
|
36
|
+
},
|
|
37
|
+
"max_rows": 1000000,
|
|
38
|
+
"missing": [
|
|
39
|
+
""
|
|
40
|
+
],
|
|
41
|
+
"flatten": true
|
|
42
|
+
},
|
|
43
|
+
"statistical_table": {
|
|
44
|
+
"path": "https://bjs.ojp.gov/document/{report}.zip",
|
|
45
|
+
"method": "GET",
|
|
46
|
+
"description": "One CSV table from a BJS report's table package (zip): Criminal Victimization, Prisoners, Jail Inmates, Probation and Parole, Capital Punishment. Default: every line numbered (row, col1...) to find the header lines; then header_lines (e.g. '11-12') names the columns.",
|
|
47
|
+
"params": {
|
|
48
|
+
"report": {
|
|
49
|
+
"in": "path",
|
|
50
|
+
"required": true,
|
|
51
|
+
"catalog": true,
|
|
52
|
+
"desc": "report package code or alias: cv24 (criminal_victimization_2024), p23st, ji24st, ppus23, cp22st ..."
|
|
53
|
+
},
|
|
54
|
+
"member": {
|
|
55
|
+
"in": "records",
|
|
56
|
+
"required": true,
|
|
57
|
+
"desc": "the table's file in the zip, e.g. cv24t01.csv (t = table, at = appendix table, f = figure); a glob works"
|
|
58
|
+
},
|
|
59
|
+
"header_lines": {
|
|
60
|
+
"in": "records",
|
|
61
|
+
"desc": "the table's header line numbers, e.g. '11-12' (read them from a first fetch without it)"
|
|
62
|
+
},
|
|
63
|
+
"header_row": {
|
|
64
|
+
"in": "records",
|
|
65
|
+
"desc": "one header line instead of header_lines; 0 (default) returns every line numbered"
|
|
66
|
+
},
|
|
67
|
+
"carry": {
|
|
68
|
+
"in": "records",
|
|
69
|
+
"desc": "which header lines span to the right over blank cells: top (default), all, none; check the names against the numbered lines"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"defaults": {
|
|
73
|
+
"header_row": 0
|
|
74
|
+
},
|
|
75
|
+
"records": "$zip:",
|
|
76
|
+
"paging": {
|
|
77
|
+
"type": "none"
|
|
78
|
+
},
|
|
79
|
+
"max_rows": 20000
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
"catalog": {
|
|
83
|
+
"personal_victimization": {
|
|
84
|
+
"id": "gcuy-rt5g",
|
|
85
|
+
"endpoint": "query",
|
|
86
|
+
"name": "NCVS Select - Personal Victimization",
|
|
87
|
+
"description": "One row per personal victimization (rape/sexual assault, robbery, aggravated and simple assault, personal theft), 1993-2024, with victim and incident characteristics; weight newwgt (series-adjusted) gives victimizations."
|
|
88
|
+
},
|
|
89
|
+
"personal_population": {
|
|
90
|
+
"id": "r4j4-fdwx",
|
|
91
|
+
"endpoint": "query",
|
|
92
|
+
"name": "NCVS Select - Personal Population",
|
|
93
|
+
"description": "Every interviewed person age 12 or older by quarter, 1993-2024, with demographics; weight wgtpercy gives persons (the rate denominator); victim and wgt_ovam_per for prevalence."
|
|
94
|
+
},
|
|
95
|
+
"household_victimization": {
|
|
96
|
+
"id": "gkck-euys",
|
|
97
|
+
"endpoint": "query",
|
|
98
|
+
"name": "NCVS Select - Household Victimization",
|
|
99
|
+
"description": "One row per household property victimization (burglary/trespassing, motor-vehicle theft, other theft), 1993-2024; weight newwgt."
|
|
100
|
+
},
|
|
101
|
+
"household_population": {
|
|
102
|
+
"id": "ya4e-n9zp",
|
|
103
|
+
"endpoint": "query",
|
|
104
|
+
"name": "NCVS Select - Household Population",
|
|
105
|
+
"description": "Every interviewed household by quarter, 1993-2024; weight wgthhcy gives households (the property-crime rate denominator)."
|
|
106
|
+
},
|
|
107
|
+
"criminal_victimization_2024": {
|
|
108
|
+
"id": "cv24",
|
|
109
|
+
"endpoint": "statistical_table",
|
|
110
|
+
"name": "Criminal Victimization, 2024 (NCJ 310547) tables",
|
|
111
|
+
"description": "Official NCVS numbers, rates per 1,000 and standard errors: violent and property victimization by type of crime 2020-2024 (cv24t01...), reporting to police, victim characteristics; appendix tables back to 1993 (cv24at01)."
|
|
112
|
+
},
|
|
113
|
+
"criminal_victimization_2023": {
|
|
114
|
+
"id": "cv23",
|
|
115
|
+
"endpoint": "statistical_table",
|
|
116
|
+
"name": "Criminal Victimization, 2023 tables",
|
|
117
|
+
"description": "The 2023 report's tables (cv23t01 ...)."
|
|
118
|
+
},
|
|
119
|
+
"prisoners_2023": {
|
|
120
|
+
"id": "p23st",
|
|
121
|
+
"endpoint": "statistical_table",
|
|
122
|
+
"name": "Prisoners in 2023 - Statistical Tables (NCJ 310197)",
|
|
123
|
+
"description": "National Prisoner Statistics: prisoners under state and federal jurisdiction by state and sex, imprisonment rates, admissions and releases, by offense, race and age (p23stt01 ... p23stt24, p23stat01 appendix)."
|
|
124
|
+
},
|
|
125
|
+
"jail_inmates_2024": {
|
|
126
|
+
"id": "ji24st",
|
|
127
|
+
"endpoint": "statistical_table",
|
|
128
|
+
"name": "Jail Inmates in 2024 - Statistical Tables",
|
|
129
|
+
"description": "Annual Survey of Jails: jail population, incarceration rates, admissions, turnover, conviction status (ji24stt01 ...)."
|
|
130
|
+
},
|
|
131
|
+
"jail_inmates_2023": {
|
|
132
|
+
"id": "ji23st",
|
|
133
|
+
"endpoint": "statistical_table",
|
|
134
|
+
"name": "Jail Inmates in 2023 - Statistical Tables",
|
|
135
|
+
"description": "The 2023 jail tables."
|
|
136
|
+
},
|
|
137
|
+
"probation_parole_2023": {
|
|
138
|
+
"id": "ppus23",
|
|
139
|
+
"endpoint": "statistical_table",
|
|
140
|
+
"name": "Probation and Parole in the United States, 2023",
|
|
141
|
+
"description": "Annual Probation and Parole Surveys: adults on probation and parole by state, entries and exits (ppus23t01 ..., figures ppus23f..)."
|
|
142
|
+
},
|
|
143
|
+
"capital_punishment_2022": {
|
|
144
|
+
"id": "cp22st",
|
|
145
|
+
"endpoint": "statistical_table",
|
|
146
|
+
"name": "Capital Punishment, 2022 - Statistical Tables",
|
|
147
|
+
"description": "Prisoners under sentence of death and executions by state and year."
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "bjs",
|
|
3
|
+
"title": "Bureau of Justice Statistics: National Crime Victimization Survey and corrections statistics",
|
|
4
|
+
"agency": "U.S. Department of Justice, Bureau of Justice Statistics",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"crime",
|
|
8
|
+
"criminal justice",
|
|
9
|
+
"public safety",
|
|
10
|
+
"corrections"
|
|
11
|
+
],
|
|
12
|
+
"keywords": [
|
|
13
|
+
"bjs",
|
|
14
|
+
"bureau of justice statistics",
|
|
15
|
+
"ncvs",
|
|
16
|
+
"national crime victimization survey",
|
|
17
|
+
"victimization",
|
|
18
|
+
"victimization rate",
|
|
19
|
+
"crime victims",
|
|
20
|
+
"crimes not reported to police",
|
|
21
|
+
"reporting to police",
|
|
22
|
+
"violent victimization",
|
|
23
|
+
"property victimization",
|
|
24
|
+
"rape",
|
|
25
|
+
"sexual assault",
|
|
26
|
+
"robbery",
|
|
27
|
+
"aggravated assault",
|
|
28
|
+
"simple assault",
|
|
29
|
+
"burglary",
|
|
30
|
+
"motor vehicle theft",
|
|
31
|
+
"domestic violence",
|
|
32
|
+
"intimate partner violence",
|
|
33
|
+
"prisoners",
|
|
34
|
+
"prison population",
|
|
35
|
+
"imprisonment rate",
|
|
36
|
+
"incarceration",
|
|
37
|
+
"national prisoner statistics",
|
|
38
|
+
"jail population",
|
|
39
|
+
"jail inmates",
|
|
40
|
+
"probation",
|
|
41
|
+
"parole",
|
|
42
|
+
"capital punishment",
|
|
43
|
+
"death row",
|
|
44
|
+
"executions"
|
|
45
|
+
],
|
|
46
|
+
"questions": [
|
|
47
|
+
"violent victimization rate per 1,000 persons by year",
|
|
48
|
+
"share of violent crimes reported to police",
|
|
49
|
+
"number of robberies or assaults according to the victimization survey",
|
|
50
|
+
"property crime victimization rate for households",
|
|
51
|
+
"state and federal prison population by state",
|
|
52
|
+
"imprisonment rate per 100,000 residents",
|
|
53
|
+
"jail population and incarceration rate",
|
|
54
|
+
"adults on probation or parole by state",
|
|
55
|
+
"prisoners under sentence of death by state"
|
|
56
|
+
],
|
|
57
|
+
"homepage": "https://bjs.ojp.gov/",
|
|
58
|
+
"terms_url": "https://bjs.ojp.gov/national-crime-victimization-survey-ncvs-api",
|
|
59
|
+
"auth": {
|
|
60
|
+
"env": null,
|
|
61
|
+
"required": "none",
|
|
62
|
+
"placement": "none",
|
|
63
|
+
"signup_url": null,
|
|
64
|
+
"echoes_key": false
|
|
65
|
+
},
|
|
66
|
+
"limits": {
|
|
67
|
+
"rps": 1,
|
|
68
|
+
"burst": 2,
|
|
69
|
+
"max_rows": 1000000
|
|
70
|
+
},
|
|
71
|
+
"routes": {
|
|
72
|
+
"api": {
|
|
73
|
+
"base": "https://api.ojp.gov/bjsdataset/v1",
|
|
74
|
+
"probe": "https://api.ojp.gov/bjsdataset/v1/gcuy-rt5g.json?$limit=1",
|
|
75
|
+
"hosts": [
|
|
76
|
+
"api.ojp.gov",
|
|
77
|
+
"bjs.ojp.gov"
|
|
78
|
+
]
|
|
79
|
+
},
|
|
80
|
+
"manual": {
|
|
81
|
+
"how": "NCVS Select: open https://api.ojp.gov/bjsdataset/v1/<id>.csv?$where=year='2024'&$limit=200000 in a browser (ids: gcuy-rt5g personal victimization, r4j4-fdwx personal population, gkck-euys household victimization, ya4e-n9zp household population) and save the CSV. Report tables: download https://bjs.ojp.gov/document/<code>.zip (e.g. cv24, p23st) from the report page. Upload the file with ingest."
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"cache": {
|
|
85
|
+
"mode": "run_only",
|
|
86
|
+
"ttl_hours": null,
|
|
87
|
+
"why": "Datasets are replaced when a new year is added; data/ is reused within a run."
|
|
88
|
+
},
|
|
89
|
+
"redistribution": {
|
|
90
|
+
"mode": "allowed",
|
|
91
|
+
"why": "BJS data and tables are U.S. government works in the public domain (17 U.S.C. 105); NCVS Select files are public-use, de-identified records."
|
|
92
|
+
},
|
|
93
|
+
"notices": [],
|
|
94
|
+
"retention": null,
|
|
95
|
+
"citation": "U.S. Department of Justice, Bureau of Justice Statistics, {dataset}, bjs.ojp.gov, retrieved {retrieved_long}.",
|
|
96
|
+
"audit_hooks": [],
|
|
97
|
+
"clarify": [
|
|
98
|
+
"Published estimate or own tabulation? BJS's report tables (statistical_table, e.g. cv24) carry the official numbers, rates and standard errors; tabulating NCVS Select records with the weights reproduces the numbers (2024 violent victimizations: 6,671,636 vs. 6,671,640 published), but standard errors need the survey design and are not computed here. Default: the report table when it has the breakdown asked for.",
|
|
99
|
+
"Victimizations, incidents or prevalence? NCVS counts victimizations by default (one per victim per crime); prevalence counts unique victims (weight wgt_ovam_per and the victim flag). Default: victimizations and the rate per 1,000 persons age 12 or older (households for property crime).",
|
|
100
|
+
"Which year? 2024 comes from the legacy half of a split sample (larger standard errors). Collection year: crimes are counted in the year of the interview, not the year they happened."
|
|
101
|
+
],
|
|
102
|
+
"formats": [
|
|
103
|
+
"json",
|
|
104
|
+
"csv",
|
|
105
|
+
"zip"
|
|
106
|
+
],
|
|
107
|
+
"aliases": [
|
|
108
|
+
"BJS",
|
|
109
|
+
"NCVS",
|
|
110
|
+
"Bureau of Justice Statistics",
|
|
111
|
+
"National Crime Victimization Survey",
|
|
112
|
+
"National Prisoner Statistics"
|
|
113
|
+
]
|
|
114
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# Bureau of Justice Statistics: National Crime Victimization Survey and corrections statistics
|
|
2
|
+
Depth: standard. Key: none. Two kinds of data:
|
|
3
|
+
- NCVS Select records from BJS's API at api.ojp.gov: the person and household files of the National Crime
|
|
4
|
+
Victimization Survey, 1993-2024 (collection years), one row per victimization, person or household, with
|
|
5
|
+
weights.
|
|
6
|
+
- The CSV tables of BJS reports from bjs.ojp.gov: Criminal Victimization (official NCVS numbers, rates and
|
|
7
|
+
standard errors), Prisoners (National Prisoner Statistics), Jail Inmates, Probation and Parole, Capital
|
|
8
|
+
Punishment.
|
|
9
|
+
|
|
10
|
+
## When to use
|
|
11
|
+
- Crime as victims report it, including crimes never reported to police: violent and property victimization
|
|
12
|
+
numbers and rates; the share reported to police; victim characteristics (age, sex, race, income); weapon,
|
|
13
|
+
injury and victim-offender relationship.
|
|
14
|
+
- People in prison or jail, on probation or parole, under sentence of death; imprisonment rates by state.
|
|
15
|
+
- Not here: crimes known to police, arrests and hate crimes (fbi); federal prosecutions and DOJ press releases
|
|
16
|
+
(doj-news); homicide (NCVS covers nonfatal crimes only; deaths by assault are in cdc); state court cases.
|
|
17
|
+
|
|
18
|
+
## Endpoints
|
|
19
|
+
| Endpoint | Returns | Parameters |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `query` | NCVS Select records (JSON rows, every value text) | `dataset` (catalog alias or 4x4 id), `$select` (plain columns), `$where`, `$order` |
|
|
22
|
+
| `statistical_table` | one CSV table of a report package | `report` (code or alias), `member` (file, e.g. `cv24t01.csv`), `header_lines` or `header_row` |
|
|
23
|
+
|
|
24
|
+
NCVS Select datasets: `personal_victimization` (gcuy-rt5g), `personal_population` (r4j4-fdwx),
|
|
25
|
+
`household_victimization` (gkck-euys), `household_population` (ya4e-n9zp). Report packages (verified
|
|
26
|
+
2026-11-07): `cv24` and `cv23` (Criminal Victimization, 2024 and 2023), `p23st` (Prisoners in 2023), `ji24st`
|
|
27
|
+
and `ji23st` (Jail Inmates), `ppus23` (Probation and Parole, 2023), `cp22st` (Capital Punishment, 2022). In a
|
|
28
|
+
package, `<code>t01.csv` is table 1, `at01` appendix table 1 (estimates with standard errors and confidence
|
|
29
|
+
intervals), `f01` figure 1. A `member` that matches nothing fails with the list of files in the zip.
|
|
30
|
+
|
|
31
|
+
## Spec examples
|
|
32
|
+
```json
|
|
33
|
+
{"description": "Violent victimization numbers and rates, 2020-2024, as BJS published them",
|
|
34
|
+
"requests": [{"name": "cv24_t01", "endpoint": "statistical_table",
|
|
35
|
+
"params": {"report": "cv24", "member": "cv24t01.csv", "header_lines": "11-12"}}]}
|
|
36
|
+
```
|
|
37
|
+
```json
|
|
38
|
+
{"description": "2024 violent victimizations by type and reporting to police, from NCVS Select records",
|
|
39
|
+
"requests": [{"name": "violent_2024", "endpoint": "query", "params": {"dataset": "personal_victimization",
|
|
40
|
+
"$select": "year, newoff, notify, newwgt", "$where": "year = '2024' AND newcrime = '1'"}},
|
|
41
|
+
{"name": "persons_2024", "endpoint": "query", "params": {"dataset": "personal_population",
|
|
42
|
+
"$select": "year, wgtpercy", "$where": "year = '2024'"}}]}
|
|
43
|
+
```
|
|
44
|
+
Then `compute`: the sum of `newwgt` by `newoff` gives victimizations. Divide by the sum of `wgtpercy` for the
|
|
45
|
+
year and multiply by 1,000 for the rate per 1,000 persons age 12 or older.
|
|
46
|
+
|
|
47
|
+
## Data format and traps
|
|
48
|
+
- Report tables (`statistical_table`): the first fetch, without `header_lines`, gives every line numbered (`row`,
|
|
49
|
+
`col1`...). Lines 1-8 are the BJS banner, file name, title, report, data source, authors and version date;
|
|
50
|
+
the title repeats above the header. Read the header line numbers, then fetch again with `header_lines` (e.g.
|
|
51
|
+
`11-12`). Column names join the stacked header (`2024* | Number`, `2024* | Rate per 1,000/a`). A column of
|
|
52
|
+
footnote marks next to a value is named `<parent>_colN`: `†` or `‡` mean the difference from the comparison year
|
|
53
|
+
(marked `*`, e.g. `2024*`) is significant at the 95% or 90% level (table 1's notes).
|
|
54
|
+
Values are text with thousands separators (`6,671,640`). Row labels carry footnote letters (`Total violent
|
|
55
|
+
crime/b`), and the notes below the table explain them. Sub-rows are indented into the next column (`col2`).
|
|
56
|
+
Keep the footnote and significance notes with any number you quote.
|
|
57
|
+
- NCVS codes, from BJS's NCVS Select codebooks (person and household level):
|
|
58
|
+
- `newcrime` (person) is 1 violent crime, 2 personal theft/larceny. `newoff` (person) is 1 rape/sexual
|
|
59
|
+
assault, 2 robbery, 3 aggravated assault, 4 simple assault, 5 personal theft/larceny. `seriousviolent` 1
|
|
60
|
+
is violent crime excluding simple assault.
|
|
61
|
+
- Household: `newcrime` 3 is property crime; `newoff` is 6 burglary/trespassing, 7 motor-vehicle theft,
|
|
62
|
+
8 theft.
|
|
63
|
+
- Demographic codes (`ager` 1-6, `sex`, `race_ethnicity` 1-6, `hincome1`, ...), the `notify` codes (reported to
|
|
64
|
+
police) and residue codes (98, -1 "invalid until ...") are in the codebooks:
|
|
65
|
+
https://bjs.ojp.gov/document/NCVS_Select_person_level_codebook.pdf and
|
|
66
|
+
https://bjs.ojp.gov/document/NCVS_Select_household_level_codebook.pdf. Read the code before filtering on it.
|
|
67
|
+
- Weights:
|
|
68
|
+
- `newwgt` is the series-adjusted victimization weight; use it for victimization counts (`wgtviccy` is the
|
|
69
|
+
unadjusted annual weight).
|
|
70
|
+
- `wgtpercy` (persons) and `wgthhcy` (households) are the population weights, the rate denominators.
|
|
71
|
+
- For prevalence (unique victims), use `wgt_ovam_per` and the `victim` flag.
|
|
72
|
+
- Never count rows: each row stands for thousands of victimizations.
|
|
73
|
+
- Reproducing BJS: the sum of `newwgt` over 2024 violent records is 6,671,636, and BJS publishes 6,671,640
|
|
74
|
+
(rounded to tens). The types match the same way (rape/sexual assault 560,890; robbery 642,150). Standard errors
|
|
75
|
+
and significance tests need the design variables (`pseudostratum`, `secucode`) and BJS's generalized variance
|
|
76
|
+
method; they are not computed here. Take them from the report's appendix tables, or say that none were computed.
|
|
77
|
+
- 2024 is the legacy-instrument half of a split sample (109,341 persons). Weights are larger and estimates less
|
|
78
|
+
precise (the codebook). Collection year: crimes are counted in the interview year, not the
|
|
79
|
+
year they happened. Victimizations outside the U.S. are excluded.
|
|
80
|
+
- Every column is text: quote values in `$where` (`year = '2024'`). Aggregate SoQL (`sum`, `count`, `$group`)
|
|
81
|
+
is refused before the request is sent, because the site answers it with a bot check. Fetch plain columns and
|
|
82
|
+
aggregate with `compute`. A year of `personal_population` has well over 100,000 rows, so select only the
|
|
83
|
+
columns you need.
|
|
84
|
+
- Small cells: a weighted sum over a handful of records is not a reliable estimate. When a tabulation splits a
|
|
85
|
+
year finely (by place size, race and crime type), say how many records are behind each cell, and prefer the
|
|
86
|
+
report tables, whose notes flag unreliable estimates. The person populations behind the rates are in
|
|
87
|
+
Criminal Victimization appendix tables (2024: appendix table 19).
|
|
88
|
+
|
|
89
|
+
## Access
|
|
90
|
+
No key. `fetch` uses api.ojp.gov (records) and bjs.ojp.gov (report zips). Keep requests few: the site has a bot
|
|
91
|
+
check. Manual: `https://api.ojp.gov/bjsdataset/v1/<id>.csv?$where=year='2024'&$limit=200000` in a browser, or
|
|
92
|
+
the "Data tables" zip on the report's page (https://bjs.ojp.gov/library/publications/...), then `ingest`. API
|
|
93
|
+
documentation: https://bjs.ojp.gov/national-crime-victimization-survey-ncvs-api.
|
|
94
|
+
|
|
95
|
+
## Citation and terms
|
|
96
|
+
"U.S. Department of Justice, Bureau of Justice Statistics, National Crime Victimization Survey, NCVS Select
|
|
97
|
+
<dataset> (or <report title and NCJ number>, table <n>), bjs.ojp.gov, retrieved <date>." Public domain (17 U.S.C.
|
|
98
|
+
105). A tabulation of NCVS Select records is the analyst's own estimate, not a BJS estimate: say so.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://www.cbp.gov",
|
|
3
|
+
"timeout": 120,
|
|
4
|
+
"document_page": "/document/stats/nationwide-encounters",
|
|
5
|
+
"endpoints": {
|
|
6
|
+
"list_files": {
|
|
7
|
+
"path": "/document/stats/nationwide-encounters",
|
|
8
|
+
"method": "GET",
|
|
9
|
+
"description": "The encounter data files CBP currently publishes (read from its Nationwide Encounters document page): one row per CSV with its path for the encounters request. The files are replaced every month.",
|
|
10
|
+
"params": {},
|
|
11
|
+
"records": "",
|
|
12
|
+
"paging": {"type": "none"},
|
|
13
|
+
"max_rows": 1000
|
|
14
|
+
},
|
|
15
|
+
"encounters": {
|
|
16
|
+
"path": "/sites/default/files/{file}.csv",
|
|
17
|
+
"method": "GET",
|
|
18
|
+
"description": "Nationwide encounters (OFO inadmissibles and Border Patrol apprehensions under Title 8) by fiscal year and month, component, land border region, area of responsibility or state, demographic and citizenship. Use list_files for the current file paths.",
|
|
19
|
+
"params": {
|
|
20
|
+
"file": {"in": "path", "raw": true, "required": true, "desc": "the file's path under /sites/default/files without .csv, from list_files, e.g. 2026-11/nationwide-encounters-fy24-fy27-oct-aor"},
|
|
21
|
+
"region": {"in": "spec", "desc": "keep these Land Border Region values: Southwest Land Border, Northern Land Border, Other"},
|
|
22
|
+
"component": {"in": "spec", "desc": "keep Office of Field Operations or U.S. Border Patrol"},
|
|
23
|
+
"fiscal_year": {"in": "spec", "desc": "keep these fiscal years as published (2025; the current year is '2027 (FYTD)')"},
|
|
24
|
+
"citizenship": {"in": "spec", "desc": "keep these citizenships as published (MEXICO, VENEZUELA ...)"}
|
|
25
|
+
},
|
|
26
|
+
"records": "$csv",
|
|
27
|
+
"paging": {"type": "none"},
|
|
28
|
+
"max_rows": 500000
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "cbp",
|
|
3
|
+
"title": "CBP nationwide encounters: border apprehensions and inadmissibles by month, region, demographic and citizenship",
|
|
4
|
+
"agency": "U.S. Department of Homeland Security, Customs and Border Protection",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"immigration",
|
|
8
|
+
"border security"
|
|
9
|
+
],
|
|
10
|
+
"keywords": [
|
|
11
|
+
"cbp",
|
|
12
|
+
"customs and border protection",
|
|
13
|
+
"border encounters",
|
|
14
|
+
"southwest border",
|
|
15
|
+
"border crossings",
|
|
16
|
+
"border apprehensions",
|
|
17
|
+
"border patrol",
|
|
18
|
+
"inadmissibles",
|
|
19
|
+
"migrant encounters",
|
|
20
|
+
"unaccompanied children",
|
|
21
|
+
"uac",
|
|
22
|
+
"family units",
|
|
23
|
+
"northern border",
|
|
24
|
+
"office of field operations"
|
|
25
|
+
],
|
|
26
|
+
"questions": [
|
|
27
|
+
"southwest border encounters by month",
|
|
28
|
+
"border apprehensions this year vs last year",
|
|
29
|
+
"encounters by citizenship (e.g. Venezuela, Mexico)",
|
|
30
|
+
"unaccompanied children encountered at the border",
|
|
31
|
+
"encounters by state or Border Patrol sector"
|
|
32
|
+
],
|
|
33
|
+
"homepage": "https://www.cbp.gov/newsroom/stats/nationwide-encounters",
|
|
34
|
+
"terms_url": "https://www.cbp.gov/document/stats/nationwide-encounters",
|
|
35
|
+
"auth": {
|
|
36
|
+
"env": null,
|
|
37
|
+
"required": "none",
|
|
38
|
+
"placement": "none",
|
|
39
|
+
"signup_url": null,
|
|
40
|
+
"echoes_key": false
|
|
41
|
+
},
|
|
42
|
+
"limits": {
|
|
43
|
+
"rps": 1,
|
|
44
|
+
"burst": 2,
|
|
45
|
+
"max_rows": 500000
|
|
46
|
+
},
|
|
47
|
+
"routes": {
|
|
48
|
+
"api": {
|
|
49
|
+
"base": "https://www.cbp.gov",
|
|
50
|
+
"probe": "https://www.cbp.gov/document/stats/nationwide-encounters",
|
|
51
|
+
"hosts": [
|
|
52
|
+
"www.cbp.gov"
|
|
53
|
+
]
|
|
54
|
+
},
|
|
55
|
+
"manual": {
|
|
56
|
+
"how": "Open https://www.cbp.gov/document/stats/nationwide-encounters, download the newest 'Nationwide Encounters' CSV (by AOR or by state), and upload it with ingest."
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"cache": {
|
|
60
|
+
"mode": "run_only",
|
|
61
|
+
"ttl_hours": null,
|
|
62
|
+
"why": "Files are replaced monthly, with revisions to earlier months."
|
|
63
|
+
},
|
|
64
|
+
"redistribution": {
|
|
65
|
+
"mode": "allowed",
|
|
66
|
+
"why": "CBP statistics are U.S. government works in the public domain (17 U.S.C. 105)."
|
|
67
|
+
},
|
|
68
|
+
"notices": [],
|
|
69
|
+
"retention": null,
|
|
70
|
+
"citation": "U.S. Customs and Border Protection, Nationwide Encounters ({dataset}), cbp.gov, retrieved {retrieved_long}.",
|
|
71
|
+
"audit_hooks": [],
|
|
72
|
+
"clarify": [
|
|
73
|
+
"Which encounters? Southwest Land Border, Northern Land Border, or nationwide (including Other: airports and seaports); Border Patrol apprehensions between ports or OFO inadmissibles at ports, or both. Default: Southwest Land Border, both components, said as such.",
|
|
74
|
+
"Which months? Federal fiscal years (October-September); the current year is partial (FYTD). Default: the latest month and the same month a year earlier."
|
|
75
|
+
],
|
|
76
|
+
"formats": [
|
|
77
|
+
"csv",
|
|
78
|
+
"html"
|
|
79
|
+
],
|
|
80
|
+
"aliases": [
|
|
81
|
+
"CBP",
|
|
82
|
+
"Customs and Border Protection",
|
|
83
|
+
"Border Patrol"
|
|
84
|
+
]
|
|
85
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# CBP nationwide encounters: border apprehensions and inadmissibles by month, region, demographic and citizenship
|
|
2
|
+
Depth: standard. Key: none. U.S. Customs and Border Protection's monthly Nationwide Encounters data files (the CSVs
|
|
3
|
+
behind CBP's encounters dashboard). They count Border Patrol apprehensions (between ports of entry) and Office of
|
|
4
|
+
Field Operations inadmissibles (at ports of entry), under Title 8. Breakdowns: fiscal year and month, land border
|
|
5
|
+
region, area of responsibility (Border Patrol sector or field office) or state, demographic and citizenship.
|
|
6
|
+
|
|
7
|
+
## When to use
|
|
8
|
+
- Southwest border encounters by month; year-over-year change; encounters by citizenship, demographic (single
|
|
9
|
+
adults, family units, unaccompanied children, accompanied minors), component, sector or field office, or state.
|
|
10
|
+
- Not here: annual immigration statistics (green cards, refugees, naturalizations, removals: dhs-ohss); asylum
|
|
11
|
+
and immigration court cases (not covered); trade and customs duties (census, usitc, treasury).
|
|
12
|
+
|
|
13
|
+
## Endpoints
|
|
14
|
+
| Endpoint | Returns | Parameters |
|
|
15
|
+
|---|---|---|
|
|
16
|
+
| `list_files` | the encounter CSVs on CBP's document page, newest first: `file`, `by` (area of responsibility or state), `fiscal_years`, `url` | none |
|
|
17
|
+
| `encounters` | one file's rows as published | `file` (from `list_files`), filters `region`, `component`, `fiscal_year`, `citizenship` |
|
|
18
|
+
|
|
19
|
+
Columns:
|
|
20
|
+
- By area of responsibility (`-aor`): Fiscal Year, Month Grouping, Month (abbv), Component, Land Border Region,
|
|
21
|
+
Area of Responsibility, AOR (Abbv), Demographic, Citizenship, Title of Authority, Encounter Type, Encounter
|
|
22
|
+
Count.
|
|
23
|
+
- By state (`-state`): Fiscal Year, Month Grouping, Month (abbv), Land Border Region, State, Demographic,
|
|
24
|
+
Citizenship, Title of Authority, Encounter Count.
|
|
25
|
+
|
|
26
|
+
## Spec example
|
|
27
|
+
```json
|
|
28
|
+
{"description": "Southwest border encounters by month, FY2024 to date (file of November 2026)",
|
|
29
|
+
"requests": [{"name": "files", "endpoint": "list_files"},
|
|
30
|
+
{"name": "swb", "endpoint": "encounters",
|
|
31
|
+
"params": {"file": "2026-11/nationwide-encounters-fy24-fy27-oct-aor", "region": "Southwest Land Border"}}]}
|
|
32
|
+
```
|
|
33
|
+
Run `list_files` first: the newest file is replaced every month (paths verified 2026-11-07).
|
|
34
|
+
|
|
35
|
+
## Data format and traps
|
|
36
|
+
- Each file covers about four fiscal years, the last one partial (`2027 (FYTD)`). Earlier months are revised in
|
|
37
|
+
later files: use the newest file, and do not mix files.
|
|
38
|
+
- `Month Grouping` is `FYTD` for the months that fall in the current fiscal year-to-date period, marked in every
|
|
39
|
+
year for comparison (only OCT in the November 2026 file), and `Remaining` for the others. Months are abbreviations (`OCT` ... `SEP`), and the fiscal year starts in October. Build a
|
|
40
|
+
date before plotting (FY2025 OCT = October 2024).
|
|
41
|
+
- Encounters are events, not people: one person can be encountered more than once.
|
|
42
|
+
- OFO inadmissibles and Border Patrol apprehensions are different events. Add them only for "total
|
|
43
|
+
encounters", and say so.
|
|
44
|
+
- `Land Border Region` `Other` holds encounters away from land borders (airports, seaports, coastal).
|
|
45
|
+
- `Citizenship` lists the main countries and groups the rest as `OTHER`: a country absent from the list is
|
|
46
|
+
inside OTHER, not zero. Demographic codes: `FMUA` is individuals in family units, `UAC` unaccompanied children,
|
|
47
|
+
plus Single Adults and Accompanied Minors.
|
|
48
|
+
- Counts are text; sum with `Number()`. Every row of the November 2026 files is Title 8: older files also have
|
|
49
|
+
Title 42 expulsions (March 2020 to May 2023), which are encounters too.
|
|
50
|
+
|
|
51
|
+
## Access
|
|
52
|
+
No key. `fetch` reads www.cbp.gov (verified 2026-11-07; the files are 2-5 MB). Manual: the document page's CSV
|
|
53
|
+
links, then `ingest`.
|
|
54
|
+
|
|
55
|
+
## Citation and terms
|
|
56
|
+
"U.S. Customs and Border Protection, Nationwide Encounters, <file name>, cbp.gov, retrieved <date>." Public
|
|
57
|
+
domain (17 U.S.C. 105).
|
package/packs/cdc/source.md
CHANGED
|
@@ -53,7 +53,7 @@ narrow `$where`), or open the dataset page.
|
|
|
53
53
|
- Provisional data (weekly deaths, VSRR overdose, quarterly mortality) are revised for months and may be
|
|
54
54
|
incomplete for recent periods; report the data date. Small counts are suppressed in several tables.
|
|
55
55
|
- Leading causes of death ends in 2017 and life expectancy in 2018 on this portal; newer years are in CDC
|
|
56
|
-
WONDER (
|
|
56
|
+
WONDER (the cdc-wonder pack, by manual export). Say so instead of mixing sources silently.
|
|
57
57
|
- Paging uses `$limit`/`$offset` with a stable `$order` (default `:id`); without a key Socrata throttles
|
|
58
58
|
heavy use (about 1,000 requests an hour). A `$group` query fails with the default order ("Column ':id'
|
|
59
59
|
is not in group by"): give it an explicit `$order` on a selected or grouped column.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://wonder.cdc.gov",
|
|
3
|
+
"timeout": 60,
|
|
4
|
+
"endpoints": {
|
|
5
|
+
"export": {
|
|
6
|
+
"path": "https://wonder.cdc.gov/",
|
|
7
|
+
"method": "GET",
|
|
8
|
+
"description": "A CDC WONDER query result, exported from the WONDER web site (Export, tab-delimited .txt) and uploaded: deaths, populations and rates by the Group By fields chosen, e.g. underlying cause of death by year, state, age, sex, race. Manual only: wonder.cdc.gov refuses this client.",
|
|
9
|
+
"params": {
|
|
10
|
+
"database": {
|
|
11
|
+
"in": "spec",
|
|
12
|
+
"required": true,
|
|
13
|
+
"desc": "the WONDER database the query ran on, as WONDER names it (e.g. 'Underlying Cause of Death, 2018-2023, Single Race'), cited with the result"
|
|
14
|
+
},
|
|
15
|
+
"query": {
|
|
16
|
+
"in": "spec",
|
|
17
|
+
"desc": "what the query selected and grouped by, in words (for INSTRUCTIONS.md and the citation)"
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"records": "$tsv",
|
|
21
|
+
"header_row": 1,
|
|
22
|
+
"paging": {"type": "none"},
|
|
23
|
+
"max_rows": 500000
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "cdc-wonder",
|
|
3
|
+
"title": "CDC WONDER: mortality, natality and population query results (manual export)",
|
|
4
|
+
"agency": "Centers for Disease Control and Prevention, National Center for Health Statistics",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"health",
|
|
8
|
+
"mortality",
|
|
9
|
+
"vital statistics"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"cdc wonder",
|
|
13
|
+
"wonder",
|
|
14
|
+
"underlying cause of death",
|
|
15
|
+
"multiple cause of death",
|
|
16
|
+
"death certificates",
|
|
17
|
+
"mortality rate",
|
|
18
|
+
"age-adjusted death rate",
|
|
19
|
+
"deaths by cause",
|
|
20
|
+
"deaths by county",
|
|
21
|
+
"icd-10",
|
|
22
|
+
"natality",
|
|
23
|
+
"births",
|
|
24
|
+
"infant mortality",
|
|
25
|
+
"linked birth infant death",
|
|
26
|
+
"compressed mortality"
|
|
27
|
+
],
|
|
28
|
+
"questions": [
|
|
29
|
+
"age-adjusted death rate for a cause of death by state and year",
|
|
30
|
+
"deaths by ICD-10 cause, age group and sex",
|
|
31
|
+
"county death rates for a cause",
|
|
32
|
+
"births by mother's age or state",
|
|
33
|
+
"infant mortality rate by race"
|
|
34
|
+
],
|
|
35
|
+
"homepage": "https://wonder.cdc.gov/",
|
|
36
|
+
"terms_url": "https://wonder.cdc.gov/datause.html",
|
|
37
|
+
"auth": {
|
|
38
|
+
"env": null,
|
|
39
|
+
"required": "none",
|
|
40
|
+
"placement": "none",
|
|
41
|
+
"signup_url": null,
|
|
42
|
+
"echoes_key": false
|
|
43
|
+
},
|
|
44
|
+
"limits": {
|
|
45
|
+
"rps": 1,
|
|
46
|
+
"burst": 1,
|
|
47
|
+
"max_rows": 500000
|
|
48
|
+
},
|
|
49
|
+
"routes": {
|
|
50
|
+
"manual": {
|
|
51
|
+
"how": "Open https://wonder.cdc.gov/ in a web browser, choose the database (e.g. Mortality: Underlying Cause of Death), read and accept its data use restrictions yourself, set Group By and the filters, click Send, then Export (tab-delimited .txt) with 'Show Totals' and notes as wanted. Upload the exported .txt file with ingest."
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"cache": {
|
|
55
|
+
"mode": "none",
|
|
56
|
+
"ttl_hours": null,
|
|
57
|
+
"why": "Nothing is fetched; the uploaded export is the data."
|
|
58
|
+
},
|
|
59
|
+
"redistribution": {
|
|
60
|
+
"mode": "aggregates_only",
|
|
61
|
+
"microdata_globs": [
|
|
62
|
+
"raw/*"
|
|
63
|
+
],
|
|
64
|
+
"why": "CDC WONDER's data use restrictions (wonder.cdc.gov/datause.html, read 2026-11-07): statistical reporting and analysis only; no attempt to identify any person or establishment; do not present or publish statistics representing nine or fewer births or deaths, including rates based on them. Exported tables are aggregates; the uploaded export stays in raw/."
|
|
65
|
+
},
|
|
66
|
+
"notices": [
|
|
67
|
+
"CDC WONDER data use restrictions (https://wonder.cdc.gov/datause.html): use for statistical reporting and analysis only; make no attempt to learn the identity of any person or establishment; do not present or publish statistics representing nine or fewer births or deaths, including rates based on counts of nine or fewer. The user accepts these on the WONDER site before running a query."
|
|
68
|
+
],
|
|
69
|
+
"retention": null,
|
|
70
|
+
"citation": "Centers for Disease Control and Prevention, National Center for Health Statistics, {dataset}, CDC WONDER Online Database, accessed {retrieved_long}.",
|
|
71
|
+
"audit_hooks": [],
|
|
72
|
+
"clarify": [
|
|
73
|
+
"Which WONDER database and years? Final mortality (e.g. Underlying Cause of Death by single race, 2018 on; the bridged-race file for 1999-2020) or provisional; natality. The cause is coded in ICD-10. Default: the newest final underlying-cause database.",
|
|
74
|
+
"Crude or age-adjusted rates? Comparing places or years needs age-adjusted rates (WONDER's 2000 U.S. standard population). Default: age-adjusted, with the counts."
|
|
75
|
+
],
|
|
76
|
+
"formats": [
|
|
77
|
+
"txt"
|
|
78
|
+
],
|
|
79
|
+
"aliases": [
|
|
80
|
+
"WONDER",
|
|
81
|
+
"CDC WONDER",
|
|
82
|
+
"Wide-ranging Online Data for Epidemiologic Research"
|
|
83
|
+
]
|
|
84
|
+
}
|