Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewhorridge authored Nov 22, 2022
1 parent 316a525 commit 6d2d7c6
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 6d2d7c6

Please sign in to comment.