From: Nathan TeBlunthuis <nathante@uw.edu>
Date: Tue, 31 Mar 2020 23:22:30 +0000 (-0700)
Subject: add documentation for the output files
X-Git-Url: https://code.communitydata.science/covid19.git/commitdiff_plain/c8b886364f8f3f3a8ee68dadba78126b57594588

add documentation for the output files
---

diff --git a/keywords/README.md b/keywords/README.md
index 5bf27ba..490d7eb 100644
--- a/keywords/README.md
+++ b/keywords/README.md
@@ -5,3 +5,10 @@ This code finds trending web searches related to the COVID-19 pandemic using Goo
 We search the Wikidata API for entities in `src/wikidata_search.py` and then we make simple SPARQL queries in `src/wikidata_translations.py` to collect labels and aliases the entities.  The labels come with language metadata.  This seems to provide a decent initial list of relevant terms across multiple languages. 
 
 The output data lives at [covid19.communitydata.science](https://covid19.communitydata.science/datasets/keywords).
+
+The output files have 4 colums: 
+
+- `itemid` links to the wikidata entity
+- `label` is the translation of the relevant keyword
+- `langcode` is the [iso 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code corresponding the language of the label. 
+- `is_alt` indicates whether the label is an [alias](https://www.wikidata.org/wiki/Help:Aliases).