Skip to content

Commit 6d2d7c6

Browse files
Update README.md
1 parent 316a525 commit 6d2d7c6

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,28 @@
22

33
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`.
44

5-
To run the script, in this repository root directory (after cloning the repo), type:
5+
## Cloning and Running the Analysis
6+
7+
Open a terminal with the working directory set to the directory where you would like to clone the repo. Type,
8+
9+
```
10+
git clone https://github.com/RADx/radx-data-dictionary-analysis.git
11+
```
12+
13+
Next, switch to the cloned repo directory, `radx-data-dictionary-analysis` directory,
14+
15+
```
16+
cd radx-data-dictionary-analysis
17+
```
18+
19+
Next run the script (see note below),
620

721
```
822
./process-data-dictionaries.sh ./curated ./generated
923
```
1024

25+
This will output processing files in the `generated` directory.
26+
1127
## RADx Data Dictionary Explorer Tool
1228

1329
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.

0 commit comments

Comments
 (0)