Skip to content

Commit c1ef416

Browse files
committed
README and schema additions
1 parent 16bc7ea commit c1ef416

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,20 @@ cat -v <file.csv>
199199

200200
If there is an unexpected symbol at the beginning of the file, then there may be a byte order marker that needs to be removed.
201201

202+
#### Troubleshooting Additional Errors
203+
The mCODE Extraction Framework uses the node `csv-parse` library to parse specified CSV files. [Parsing options for the `csv-parse` library](https://csv.js.org/parse/options/) can be included in the configuration file within the `commonExtractorArgs.csvParse.options` section. For example, the following configuration will pass the `to` option to the `csv-parse` module, causing the mCODE Extraction Framework to only read CSV files up to the specified line number:
204+
205+
```
206+
"commonExtractorArgs": {
207+
"dataDirectory": "/Users/*****/Documents/dataDirectory",
208+
"csvParse": {
209+
"options": {
210+
"to": 3
211+
}
212+
}
213+
},
214+
```
215+
202216
## Terminology and Architecture
203217

204218
This framework consists of three key components: Extractors, Modules and Templates. Below is, in order:

src/helpers/schemas/config.schema.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@
4040
"requestHeaders": {
4141
"title": "Request Headers",
4242
"type": "object"
43+
},
44+
"csvParse" : {
45+
"title": "CSV Parse",
46+
"type": "object",
47+
"properties": {
48+
"options": {
49+
"titles": "Options",
50+
"description": "Options to be passed to the \"CSV Parse\" module used for parsing CSV files.",
51+
"type": "object"
52+
}
53+
}
4354
}
4455
}
4556
},

0 commit comments

Comments
 (0)