Commit
·
85034fa
1
Parent(s):
79a7034
"Table of contents" appears to be a reserved word in README.md
Browse files
README.md
CHANGED
|
@@ -37,12 +37,13 @@ Prepared by the [Harvard Library Innovation Lab](https://lil.law.harvard.edu) in
|
|
| 37 |
|
| 38 |
---
|
| 39 |
|
| 40 |
-
|
| 41 |
## Links
|
| 42 |
- [Data nutrition label](https://datanutrition.org/labels/v3/?id=c29976b2-858c-4f4e-b7d0-c8ef12ce7dbe) (DRAFT). ([Archive](https://perma.cc/YV5P-B8JL)).
|
| 43 |
- [Pipeline source code](https://github.com/harvard-lil/cold-cases-export)
|
| 44 |
|
| 45 |
-
|
|
|
|
|
|
|
| 46 |
- [Formats](#formats)
|
| 47 |
- [File structure](#file-structure)
|
| 48 |
- [Data dictionary](#data-dictionary)
|
|
@@ -70,7 +71,7 @@ Parquet has more limited support outside the Python and JVM ecosystems, however.
|
|
| 70 |
|
| 71 |
See: https://parquet.apache.org/
|
| 72 |
|
| 73 |
-
[☝️ Go back to Summary](#
|
| 74 |
|
| 75 |
---
|
| 76 |
|
|
@@ -82,7 +83,7 @@ Both of these datasets were exported by the same system based on [Apache Spark](
|
|
| 82 |
- **.json.gz or .gz.parquet**: Each of these is a slice of the full dataset, encoded in JSON-L or Parquet, and compressed with [GZip](https://www.gnu.org/software/gzip/).
|
| 83 |
- **Hidden `.crc` files**: These can be used to verify that the data transferred correctly and otherwise ignored.
|
| 84 |
|
| 85 |
-
[☝️ Go back to Summary](#
|
| 86 |
|
| 87 |
---
|
| 88 |
|
|
@@ -120,7 +121,7 @@ Partial glossary of the fields in the data.
|
|
| 120 |
| `opinions.opinion_text` | Actual full text of the opinion. |
|
| 121 |
| `opinions.ocr` | Whether the opinion was captured via optical character recognition or born-digital text. |
|
| 122 |
|
| 123 |
-
[☝️ Go back to Summary](#
|
| 124 |
|
| 125 |
## Notes on appropriate use
|
| 126 |
|
|
@@ -138,4 +139,4 @@ When using this data, please keep in mind:
|
|
| 138 |
To mitigate privacy risks, we have filtered out cases [blocked or deindexed by CourtListener](https://www.courtlistener.com/terms/#removal). Researchers who
|
| 139 |
require access to the full dataset without that filter may rerun our pipeline on CourtListener's raw data.
|
| 140 |
|
| 141 |
-
[☝️ Go back to Summary](#
|
|
|
|
| 37 |
|
| 38 |
---
|
| 39 |
|
|
|
|
| 40 |
## Links
|
| 41 |
- [Data nutrition label](https://datanutrition.org/labels/v3/?id=c29976b2-858c-4f4e-b7d0-c8ef12ce7dbe) (DRAFT). ([Archive](https://perma.cc/YV5P-B8JL)).
|
| 42 |
- [Pipeline source code](https://github.com/harvard-lil/cold-cases-export)
|
| 43 |
|
| 44 |
+
---
|
| 45 |
+
|
| 46 |
+
## Summary
|
| 47 |
- [Formats](#formats)
|
| 48 |
- [File structure](#file-structure)
|
| 49 |
- [Data dictionary](#data-dictionary)
|
|
|
|
| 71 |
|
| 72 |
See: https://parquet.apache.org/
|
| 73 |
|
| 74 |
+
[☝️ Go back to Summary](#summary)
|
| 75 |
|
| 76 |
---
|
| 77 |
|
|
|
|
| 83 |
- **.json.gz or .gz.parquet**: Each of these is a slice of the full dataset, encoded in JSON-L or Parquet, and compressed with [GZip](https://www.gnu.org/software/gzip/).
|
| 84 |
- **Hidden `.crc` files**: These can be used to verify that the data transferred correctly and otherwise ignored.
|
| 85 |
|
| 86 |
+
[☝️ Go back to Summary](#summary)
|
| 87 |
|
| 88 |
---
|
| 89 |
|
|
|
|
| 121 |
| `opinions.opinion_text` | Actual full text of the opinion. |
|
| 122 |
| `opinions.ocr` | Whether the opinion was captured via optical character recognition or born-digital text. |
|
| 123 |
|
| 124 |
+
[☝️ Go back to Summary](#summary)
|
| 125 |
|
| 126 |
## Notes on appropriate use
|
| 127 |
|
|
|
|
| 139 |
To mitigate privacy risks, we have filtered out cases [blocked or deindexed by CourtListener](https://www.courtlistener.com/terms/#removal). Researchers who
|
| 140 |
require access to the full dataset without that filter may rerun our pipeline on CourtListener's raw data.
|
| 141 |
|
| 142 |
+
[☝️ Go back to Summary](#summary)
|