Skip to content

Commit 0d8cdd0

Browse files
authored
Update README.md
1 parent 39f4542 commit 0d8cdd0

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,34 @@
33
# boomer
44
Bayesian OWL ontology merging
55

6+
## Usage
7+
8+
```
9+
Usage: boomer [options]
10+
--usage <bool>
11+
Print usage and exit
12+
--help | -h <bool>
13+
Print help message and exit
14+
--output | -o <output files/dir name>
15+
Name used for folder to ouput clique JSON files; also basename for ontology and Markdown output files.
16+
--ptable | -t <filename>
17+
TSV file containing table of mappings with probabilities.
18+
--ontology | -a <filename>
19+
OWL file containing all asserted/background axioms.
20+
--prefixes | -p <filename>
21+
YAML dictionary of prefix-to-expansion mappings for all prefixes used in the ptable. These namespaces are also used to check for new within-namespace equivalences.
22+
--window-count | -w <positive integer>
23+
Number of groups to split a clique of mappings into when shuffling between greedy search runs. Windows maintain their order; mappings within a window are shuffled.
24+
--runs | -r <positive integer>
25+
Number of separate shuffled runs to conduct for each greedy search.
26+
--exhaustive-search-limit | -e <positive integer>
27+
Maximum size clique for exhaustive search algorithm. Larger cliques use greedy search.
28+
--output-internal-axioms | -e <bool>
29+
Include axioms used to enforce proper subclass relationships (e.g. generated disjoint sibling classes) in OWL output (default false).
30+
--restrict-output-to-prefixes | -e <prefix strings (max of 2)>
31+
Generate output only for cliques where a mapping between these two namespaces was resolved as something other than its highest probability option.
32+
```
33+
634
## Running
735

836
`boomer` doesn't have releases or much of a command-line interface at the moment. Currently there is a `Main` class specialized for the term mapping use case. First, clone the repository and build the command-line package:

0 commit comments

Comments
 (0)