From 6d2d7c6323fca2cda45bffe89049fd2547338865 Mon Sep 17 00:00:00 2001 From: Matthew Horridge Date: Tue, 22 Nov 2022 14:46:23 -0800 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 447197b..d1abfaa 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,28 @@ A repository for the analysis of various RADx data dictionaries. The repo contains a folder called "curated" that contains a collection of cleaned data dictionaries by Data Collection Center (DCC). To process the data dictionaries run the "process-data-dictionaries.sh" script. The processing will produce a series of folders containing intermediate processed data dictionaries and then a merge of all data dictionaries in a file called `merged.csv`. -To run the script, in this repository root directory (after cloning the repo), type: +## Cloning and Running the Analysis + +Open a terminal with the working directory set to the directory where you would like to clone the repo. Type, + +``` +git clone https://github.com/RADx/radx-data-dictionary-analysis.git +``` + +Next, switch to the cloned repo directory, `radx-data-dictionary-analysis` directory, + +``` +cd radx-data-dictionary-analysis +``` + +Next run the script (see note below), ``` ./process-data-dictionaries.sh ./curated ./generated ``` +This will output processing files in the `generated` directory. + ## RADx Data Dictionary Explorer Tool This script requires the [RADx Data Dictionary Explorer](https://github.com/RADx/radx-data-dictionary-explorer) command line tool. The script uses an alias `dd` to this tool. You should build and install the tool and then set up an alias to the tool.