Update README.md

README.md

@@ -21,6 +21,7 @@ Prepared by the [Harvard Library Innovation Lab](https://lil.law.harvard.edu) in
 ## Summary
 - [Formats](#formats)
 - [File structure](#file-structure)
+- [Data Dictionnary](#data-dictionnary)
 - [Data Nutrition Label](https://datanutrition.org/labels/v3/?id=c29976b2-858c-4f4e-b7d0-c8ef12ce7dbe) (DRAFT). ([Archive](https://perma.cc/YV5P-B8JL)).
 - [Pipeline Source Code](https://github.com/harvard-lil/cold-cases-export)
 
@@ -55,6 +56,41 @@ See: https://parquet.apache.org/
 Both of these datasets were exported by the same system based on [Apache Spark](https://spark.apache.org/), so within each subdirectory, you'll find a similar list of files:
 
 - **_SUCCESS**: This indicates that the job that built the dataset ran successfully and therefore this is a complete dataset.
-
 - **.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/).
-- **Hidden `.crc` files**: These can be used to verify that the data transferred correctly and otherwise ignored.
+- **Hidden `.crc` files**: These can be used to verify that the data transferred correctly and otherwise ignored.
+
+---
+
+## Data dictionary
+
+Partial glossary of the fields in the data.
+
+| Field name | Description |
+| --- | --- |
+| `judges` |  Names of judges presiding over the case, extracted from the text. |
+| `date_filed` |  Date the case was filed. Formatted in ISO Date format. |
+| `date_filed_is_approximate` |  Boolean representing whether or not the `date_filed` values are definitively correct. |
+| `slug` |  Short, human-readable unique string nickname for the case. |
+| `case_name_short` |  Short name for the case. |
+| `case_name` |  Fuller name for the case. |
+| `case_name_full` |  Full, formal name for the case. |
+| `attorneys` |  Names of attorneys arguing the case, extracted from the text. |
+| `nature_of_suit` |  Free text representinng ype of suit, such as Civil, Tort, etc. |
+| `syllabus` |  Summary of the questions addressed by the court in the decision. |
+| `headnotes` |  Textural headnotes of the case |
+| `summary` |  Textural summary of the case |
+| `disposition` |  How the court disposed of the case in their final ruling. |
+| `history` |  Textural information about what happened to this case in later decisions. |
+| `other_dates` |  Other dates related to the case in free text. |
+| `cross_reference` |  Citations to related cases. |
+| `citation_count` |  Number of cases that cite this one. |
+| `precedential_status` |  Constrainted to the values "Published", "Unknown", "Errata", "Unpublished", "Relating-to", "Separate", "In-chambers" |
+| `citations` |  Cases that cite this case. |
+| `opinions` |  An array of subrecords with the following fields: |
+|  `author_str` |  Name of the author of an individual opinion |
+| `per_curiam` |  Boolean representing whether the opinion was delivered by an entire court or a single judge |
+| `type` |  One of "010combined", "015unamimous", "020lead", "025plurality", "030concurrence", "035concurrenceinpart", "040dissent", "050addendum", "060remittitur", "070rehearing", "080onthemerits", "090onmotiontostrike" |
+| `opinion_text` |  Actual full text of the opinion. |
+| `ocr` |  Whether or not the opinion was captured via optical character recognition. |
+| `court_short_name` |  Short name of court presiding over case. |
+| `court_full_name` |  Full name of court presiding over case. |