Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation of excel2onto #456

Merged
merged 2 commits into from
Sep 8, 2022
Merged

Added documentation of excel2onto #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f98376
Added documentation of excel2onto.
jesper-friis Sep 2, 2022
51fbc44
Merge branch 'master' into document-excel2onto
jesper-friis Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ On top of that EMMOntoPy provides:
Documents an ontology.
- [`ontoconvert`](docs/tools-instructions.md#ontoconvert):
Converts between ontology formats.
- [`excel2onto`](docs/tools-instructions.md#excel2onto):
Generate an EMMO-based ontology from an excel file.

Some examples of what you can do with EMMOntoPy includes:

Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ On top of that EMMOntoPy provides:
Documents an ontology.
- [`ontoconvert`](tools-instructions.md#ontoconvert):
Converts between ontology formats.
- [`excel2onto`](tools-instructions.md#excel2onto):
Generate an EMMO-based ontology from an excel file.

Some examples of what you can do with EMMOntoPy includes:

Expand Down
44 changes: 44 additions & 0 deletions docs/tools-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- [ontograph](#ontograph)
- [ontodoc](#ontodoc)
- [ontoconvert](#ontoconvert)
- [excel2onto](#excel2onto)

---

Expand Down Expand Up @@ -361,3 +362,46 @@ ontoconvert --recursive emmo.ttl owl/emmo.owl
### Bugs
Since parsing the results from the reasoner is currently broken in Owlready2 (v0.37), a workaround has been added to ontoconvert.
This workaround only only supports FaCT++. Hence, HermiT and Pellet are currently not available.


## `excel2onto`

Tool for converting EMMO-based ontologies from Excel to OWL, making it easy for non-ontologists to make EMMO-based domain ontologies.

The Excel file must be in the format provided by ontology_template.xlsx.

### Usage

```console
excel2onto [options] excelpath
```

### Dependencies

- `pandas` (Python package)

### Options

```console
positional arguments:
excelpath path to excel book

options:
-h, --help show this help message and exit
--output OUTPUT, -o OUTPUT
Name of output ontology, ´ontology.ttl´ is default
--force, -f Whether to force generation of ontology on non-fatal
error.
Copy link
Collaborator

@francescalb francescalb Sep 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error.
error. This generally means that the erroneously defined concept/line
will be ommitted in the ontology generation.
Identified errors will be printed as warnings in the console.

```

### Examples

Create a `new_ontology.ttl` turtle file from the Excel file `new_ontology.xlsx`:
```console
excel2onto -o new_ontology.ttl new_ontology.xlsx
```


### Bugs

`equivalentTo` is currently not supported.