diff --git a/README.md b/README.md index 4ebc592a32012598ccfb4854a5ae3bcc1abd7061..3bd9fd947a4d5833ea962414ccff5d58b0ad0bfd 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ Please execute the following process: --- -## **Example** +## **Example Usage** Follow these steps to initialize and manage a phenotype using `acmc`. In this example, we use a source concept code list for the Concept Set `Abdominal Pain` created from [ClinicalCodes.org](ClinicalCodes.org). The source concept codes are is read2. We genereate versioned phenotypes for read2 and then translate to snomed with a another version. @@ -151,7 +151,7 @@ Follow these steps to initialize and manage a phenotype using `acmc`. In this ex acmc phen init ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Initialising Phenotype in directory: <path>/concepts-processing/workspace/phen @@ -189,7 +189,7 @@ cp -r ./examples/config.json ./workspace/phen acmc phen validate ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Validating phenotype: <path>/concepts-processing/workspace/phen @@ -204,7 +204,7 @@ acmc phen validate acmc phen map -t read2 ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Processing phenotype: <path>/concepts-processing/workspace/phen @@ -226,7 +226,7 @@ The concept sets translating read2 to the acmc normalised CSV format will be sto acmc phen publish ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Validating phenotype: /home/mjbonifa/datahdd/brcbat/derived_datasets/mjbonifa/concepts-processing/workspace/phen @@ -243,7 +243,7 @@ Generate the phenotype in `snomed` format: acmc phen map -t snomed ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Processing phenotype: <path>/concepts-processing/workspace/phen @@ -265,7 +265,7 @@ The concept sets translating read2 to snomed will be stored in acmc CSV format i acmc phen copy -v v1.0.3 ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Validating phenotype: <path>/concepts-processing/workspace/phen @@ -285,7 +285,7 @@ A copy of the phenotype will be created in the directory `./workspace/v1.0.3` acmc phen diff -old ./workspace/v1.0.3/ ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Validating phenotype: ./workspace/v1.0.3/ @@ -305,7 +305,7 @@ A report comparing the phenotype versions will be created in the workspace calle acmc phen publish ``` -**Expected Output:** +Expected Output: ```bash [INFO] - Validating phenotype: /home/mjbonifa/datahdd/brcbat/derived_datasets/mjbonifa/concepts-processing/workspace/phen