rename lib to verificado (#12)

Co-authored-by: Anita Caron <anitacaron@users.noreply.github.com>

Author: Anita Caron

README.md

@@ -1,4 +1,4 @@
-# Relationship validator [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10557435.svg)](https://doi.org/10.5281/zenodo.10557435)
+# Verificado [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10557435.svg)](https://doi.org/10.5281/zenodo.10557435)
 
 
 Validate ontology relationships using [Ubergraph](https://zenodo.org/record/7249759#.ZDRuZOzML1c) as source of truth. Relationships in this context may be subClassOf axioms between names classes (e.g. 'lymphocyte' subClassOf 'cell') or existential restrictions, (e.g. 'enterocyte' part_of some ‘intestinal epithelium’).
@@ -38,9 +38,9 @@ Then install the `obographviz` package globally:
 npm install -g obographviz
 ```
 
-### `relation-validator` package
+### `verificado` package
 ```bash
-pip install relation-validator
+pip install verificado
 ```
 
 ## Configure YAML file
@@ -60,18 +60,32 @@ relationships:
 filename: path/to/filename.csv
 ```
 
-The filename can be in TSV or CSV and should have the following columns:
+The filename can be in TSV or CSV. When using CSV, double-quote if the label contains a common. It's preferred to have the following columns:
 
 | s                   | slabel                                | user_slabel                               | o                  | olabel                                | user_olabel                               |
 |---------------------|---------------------------------------|-------------------------------------------|--------------------|---------------------------------------|-------------------------------------------|
 | the subject term ID | the label of the term in the column s | optional label for the term given by user | the object term ID | the label of the term in the column s | optional label for the term given by user |
 
-When using CSV, double-quote if the label contains a common.
+However, the package can also accept TSV or CSV files representing a hierarchy. You can specify an undetermined number of levels, each level defined with an ontology term ID and the label of the term. Please check [an example](tests/test-generic.tsv) in the tests directory.
 
-## Run relation-validator CLI
+Add `to_be_parsed: true` to the yaml file when using this type of file.
+
+```yaml
+relationships:
+  sub_class_of: rdfs:subClassOf
+  part_of: BFO:0000050
+  connected_to: RO:0001025
+  has_soma_location: RO:0002100
+  ...
+
+filename: path/to/filename.csv
+to_be_parsed: true
+```
+
+## Run verificado CLI
 
 ```bash
-relation-validator validate --input path/to/config.yaml --output path/to/output.csv
+verificado validate --input path/to/config.yaml --output path/to/output.csv
 ```
 
 The `output.csv` file will be in the same format as the `filename.csv`. It will return the cases where a triple (subject, relationship, object) with the relationships listed in the yaml file was not found in Ubergraph.
@@ -81,5 +95,5 @@ The `output.csv` file will be in the same format as the `filename.csv`. It will
 To know which ontologies and their version are available in Ubergraph, use the following CLI:
 
 ```bash
-relation-validator ontologies_version --output filename.json
+verificado ontologies_version --output filename.json
 ```

pyproject.toml

@@ -1,11 +1,11 @@
 [tool.poetry]
-name = "relation-validator"
-version = "0.5.1"
+name = "verificado"
+version = "1.0"
 description = "This package validates a list of relationships between two terms against the specified ontologies."
 authors = ["Anita Caron <anitac@ebi.ac.uk>"]
 readme = "README.md"
-packages = [{include = "relation_validator", from="src"}]
-repository = "https://github.com/INCATools/relation-validator"
+packages = [{include = "verificado", from="src"}]
+repository = "https://github.com/INCATools/verificado"
 
 [tool.poetry.dependencies]
 python = "^3.8"
@@ -19,4 +19,4 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.scripts]
-relation-validator = 'relation_validator.__main__:main'
+verificado = 'verificado.__main__:main'

src/relation_validator/__init__.py src/verificado/__init__.pysrc/relation_validator/__init__.py renamed to src/verificado/__init__.py

@@ -43,7 +43,7 @@
         "RO:0002176": {
             "color": "dodgerblue1",
             "label": "connects"
-        },     
+        },
         "not_matched": {
             "color": "red"
         }

src/relation_validator/__main__.py src/verificado/__main__.pysrc/relation_validator/__main__.py renamed to src/verificado/__main__.py

@@ -12,7 +12,7 @@
 from pandas import DataFrame
 from ruamel.yaml import YAML, YAMLError
 
-from relation_validator import conf as conf_package
+from verificado import conf as conf_package
 
 QUERY = """
     VALUES (?subject ?object) {{