Update README.md
Browse files
README.md
CHANGED
@@ -22,9 +22,9 @@ Prepared by the [Harvard Library Innovation Lab](https://lil.law.harvard.edu) in
|
|
22 |
## Summary
|
23 |
- [Formats](#formats)
|
24 |
- [File structure](#file-structure)
|
25 |
-
- [Data
|
26 |
-
- [Data
|
27 |
-
- [Pipeline
|
28 |
|
29 |
---
|
30 |
|
@@ -34,11 +34,9 @@ We've released this data in two different formats:
|
|
34 |
|
35 |
### JSON-L or JSON Lines
|
36 |
|
37 |
-
This format consists of a JSON document for every row in the dataset, one per line. This makes
|
38 |
|
39 |
-
|
40 |
-
|
41 |
-
Also, just about any language you can think of has a ready way to parse JSON data, which makes this version of the dataset more compatible.
|
42 |
|
43 |
See: https://jsonlines.org/
|
44 |
|
@@ -74,18 +72,18 @@ Partial glossary of the fields in the data.
|
|
74 |
| --- | --- |
|
75 |
| `judges` | Names of judges presiding over the case, extracted from the text. |
|
76 |
| `date_filed` | Date the case was filed. Formatted in ISO Date format. |
|
77 |
-
| `date_filed_is_approximate` | Boolean representing whether
|
78 |
| `slug` | Short, human-readable unique string nickname for the case. |
|
79 |
| `case_name_short` | Short name for the case. |
|
80 |
| `case_name` | Fuller name for the case. |
|
81 |
| `case_name_full` | Full, formal name for the case. |
|
82 |
| `attorneys` | Names of attorneys arguing the case, extracted from the text. |
|
83 |
-
| `nature_of_suit` | Free text representinng
|
84 |
-
| `syllabus` | Summary of the questions addressed
|
85 |
-
| `headnotes` |
|
86 |
-
| `summary` |
|
87 |
| `disposition` | How the court disposed of the case in their final ruling. |
|
88 |
-
| `history` |
|
89 |
| `other_dates` | Other dates related to the case in free text. |
|
90 |
| `cross_reference` | Citations to related cases. |
|
91 |
| `citation_count` | Number of cases that cite this one. |
|
@@ -94,11 +92,10 @@ Partial glossary of the fields in the data.
|
|
94 |
| `court_short_name` | Short name of court presiding over case. |
|
95 |
| `court_full_name` | Full name of court presiding over case. |
|
96 |
| `opinions` | An array of subrecords. |
|
97 |
-
| `opinions.author_str` | Name of the author of an individual opinion.
|
98 |
-
| `opinions.per_curiam` | Boolean representing whether the opinion was delivered by an entire court or a single judge.
|
99 |
-
| `opinions.type` | One of `"010combined"`, `"015unamimous"`, `"020lead"`, `"025plurality"`, `"030concurrence"`, `"035concurrenceinpart"`, `"040dissent"`, `"050addendum"`, `"060remittitur"`, `"070rehearing"`, `"080onthemerits"`, `"090onmotiontostrike"`.
|
100 |
-
| `opinions.opinion_text` | Actual full text of the opinion.
|
101 |
-
| `opinions.ocr` | Whether
|
102 |
-
|
103 |
|
104 |
-
[☝️ Go back to Summary](#summary)
|
|
|
22 |
## Summary
|
23 |
- [Formats](#formats)
|
24 |
- [File structure](#file-structure)
|
25 |
+
- [Data dictionary](#data-dictionary)
|
26 |
+
- [Data nutrition label](https://datanutrition.org/labels/v3/?id=c29976b2-858c-4f4e-b7d0-c8ef12ce7dbe) (DRAFT). ([Archive](https://perma.cc/YV5P-B8JL)).
|
27 |
+
- [Pipeline source code](https://github.com/harvard-lil/cold-cases-export)
|
28 |
|
29 |
---
|
30 |
|
|
|
34 |
|
35 |
### JSON-L or JSON Lines
|
36 |
|
37 |
+
This format consists of a JSON document for every row in the dataset, one per line. This makes it easy to sample a selection of the data or split it out into multiple files for parallel processing using ordinary command line tools such as `head`, `split` and `jq`.
|
38 |
|
39 |
+
Just about any language you can think of has a ready way to parse JSON data, which makes this version of the dataset more compatible.
|
|
|
|
|
40 |
|
41 |
See: https://jsonlines.org/
|
42 |
|
|
|
72 |
| --- | --- |
|
73 |
| `judges` | Names of judges presiding over the case, extracted from the text. |
|
74 |
| `date_filed` | Date the case was filed. Formatted in ISO Date format. |
|
75 |
+
| `date_filed_is_approximate` | Boolean representing whether the `date_filed` value is precise to the day. |
|
76 |
| `slug` | Short, human-readable unique string nickname for the case. |
|
77 |
| `case_name_short` | Short name for the case. |
|
78 |
| `case_name` | Fuller name for the case. |
|
79 |
| `case_name_full` | Full, formal name for the case. |
|
80 |
| `attorneys` | Names of attorneys arguing the case, extracted from the text. |
|
81 |
+
| `nature_of_suit` | Free text representinng type of suit, such as Civil, Tort, etc. |
|
82 |
+
| `syllabus` | Summary of the questions addressed in the decision, if provided by the reporter of decisions. |
|
83 |
+
| `headnotes` | Textual headnotes of the case |
|
84 |
+
| `summary` | Textual summary of the case |
|
85 |
| `disposition` | How the court disposed of the case in their final ruling. |
|
86 |
+
| `history` | Textual information about what happened to this case in later decisions. |
|
87 |
| `other_dates` | Other dates related to the case in free text. |
|
88 |
| `cross_reference` | Citations to related cases. |
|
89 |
| `citation_count` | Number of cases that cite this one. |
|
|
|
92 |
| `court_short_name` | Short name of court presiding over case. |
|
93 |
| `court_full_name` | Full name of court presiding over case. |
|
94 |
| `opinions` | An array of subrecords. |
|
95 |
+
| `opinions.author_str` | Name of the author of an individual opinion. |
|
96 |
+
| `opinions.per_curiam` | Boolean representing whether the opinion was delivered by an entire court or a single judge. |
|
97 |
+
| `opinions.type` | One of `"010combined"`, `"015unamimous"`, `"020lead"`, `"025plurality"`, `"030concurrence"`, `"035concurrenceinpart"`, `"040dissent"`, `"050addendum"`, `"060remittitur"`, `"070rehearing"`, `"080onthemerits"`, `"090onmotiontostrike"`. |
|
98 |
+
| `opinions.opinion_text` | Actual full text of the opinion. |
|
99 |
+
| `opinions.ocr` | Whether the opinion was captured via optical character recognition or born-digital text. |
|
|
|
100 |
|
101 |
+
[☝️ Go back to Summary](#summary)
|