Skip to content

Commit 46d3898

Browse files
committed
Updates README to include recent command line arguments
1 parent dfc0029 commit 46d3898

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

README.md

+19-7
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,25 @@
22

33
Tool to convert from domain model CSV files to an NQ file.
44

5-
Command line is 'python csv2nq.py [OPTIONS] -i inputDir -o outputFile', where
5+
Usage: `csv2nq.py [-h] -i directory -o filename [-m filename] [-u] [-e] [-v VERSION] [-n NAME]`
66

7-
- inputDir is a directory containing domain model source tables in CSV format
8-
- outputFile is the path and file name for the generated NQ output
7+
```
8+
-i directory, --input directory
9+
Directory containing CSV files for input
10+
-o filename, --output filename
11+
Output NQ filename
12+
```
913

10-
and OPTIONS are optional as follows:
14+
Optional arguments are:
1115

12-
- '-u' or '--unfiltered': mean SSM GUI visibility flags are overridden and always set to 'true'
13-
- '-e' or '--expanded': means population model triplets and related properties will be inserted
14-
- '-m file.json' or '--mapping file.json': output JSON icon-mapping to `file.json`
16+
```
17+
-h, --help show this help message and exit
18+
-m filename, --mapping filename
19+
Output JSON icon-mapping filename
20+
-u, --unfiltered Causes SSM GUI Misbehaviour and TWA visibility flags to be set to true.
21+
-e, --expanded Add population model support by expanding relevant structures
22+
-v VERSION, --version VERSION
23+
Set the versionInfo string (defaults to timestamp) '-unfiltered' will be added to the version string if '-u' is used.
24+
-n NAME, --name NAME Set the domainGraph string (defaults to what is found in DomainModel.csv). '-unexpanded' will be appended for population models unless '-e'
25+
is used.
26+
```

csv2nq.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -2031,7 +2031,7 @@ def output_mapping_file(mapping_filename, ontology, domain_graph):
20312031
parser.add_argument("-m", "--mapping", dest="mapping", metavar="filename", help="Output JSON icon-mapping filename")
20322032
parser.add_argument("-u", "--unfiltered", help="Causes SSM GUI Misbehaviour and TWA visibility flags to be set to true.", action="store_true")
20332033
parser.add_argument("-e", "--expanded", help="Add population model support by expanding relevant structures", action="store_true")
2034-
parser.add_argument("-v", "--version", help="Set the versionInfo string (defaults to timestamp) '-unfiltered' will be added to the version string is '-u' is used.")
2034+
parser.add_argument("-v", "--version", help="Set the versionInfo string (defaults to timestamp) '-unfiltered' will be added to the version string if '-u' is used.")
20352035
parser.add_argument("-n", "--name", help="Set the domainGraph string (defaults to what is found in DomainModel.csv). '-unexpanded' will be appended for population models unless '-e' is used.")
20362036
raw = parser.parse_args()
20372037
args = vars(raw)

0 commit comments

Comments
 (0)