diff --git a/README.md b/README.md index 831ec31..d7697a3 100644 --- a/README.md +++ b/README.md @@ -84,14 +84,24 @@ parameters to include inferred axiom generators: ### Validate OWL2 profiles -Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full). The ontology is annotated in the output graph. +Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full) and annotate the result graph. ### Process valid OWL profiles from input -If enabled along with the "Validate OWL2 profiles" parameter, the ontology IRI and list of valid profiles is taken from the config port input, -without validating the ontology against the profiles in the plugin. If the "Validate OWL2 profiles" parameter is enabled in the "Validate" plugin, it can be directly connected to the input -of the "Reason" plugin. +If enabled along with the "Validate OWL2 profiles" parameter, the valid profiles and ontology IRI is taken from the +config port input (parameters "valid_profiles" and "ontology_graph_iri") instead of from running the validation in the +plugin. The valid profiles input is a comma-separated string (e.g. "Full,DL").the ontology IRI and list of valid +profiles is taken from the config port input, without validating the ontology against the profiles in the plugin. If the +"Validate OWL2 profiles" parameter is enabled in the "Validate" plugin, it can be directly connected to the input of the +"Reason" plugin. +### Add ontology graph import to result graph + +Add the triple ` owl:imports ` to the output graph. + +### Add result graph import to ontology graph + +Add the triple ` owl:imports ` to the ontology graph ### Maximum RAM Percentage @@ -146,9 +156,12 @@ Raise an error if inconsistencies are found. If enabled, the plugin does not out ### Validate OWL2 profiles -Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full). The valid profiles are added to the output -Markdown file and the ontology is annotated in the output graph. The plugin outputs the profiles with path "profile", -and the ontology IRI with path "ontology". +Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full) and annotate the result graph. + +### Output entities + +Output entities. The plugin outputs the explanation as text in Markdown format on the path "markdown", the ontology IRI +on the path "ontology_graph_iri", and, if enabled, the valid OWL2 profiles on the path "valid_profiles ### Maximum RAM Percentage diff --git a/cmem_plugin_reason/plugin_reason.py b/cmem_plugin_reason/plugin_reason.py index 39ce138..bf4d0fd 100644 --- a/cmem_plugin_reason/plugin_reason.py +++ b/cmem_plugin_reason/plugin_reason.py @@ -174,10 +174,10 @@ param_type=BoolParameterType(), name="input_profiles", label="Process valid OWL profiles from input", - description="""If the "validate OWL profiles" parameter is enabled, the valid profiles - and ontology IRI is taken from the config port input (parameters "valid_profiles" and - "ontology_graph_iri") instead of from running the validation in the plugin. The valid - profiles input is a comma-separated string (e.g. "Full,DL").""", + description="""If enabled along with the "Validate OWL2 profiles" parameter, the valid + profiles and ontology IRI is taken from the config port input (parameters + "valid_profiles" and "ontology_graph_iri") instead of from running the validation in the + plugin. The valid profiles input is a comma-separated string (e.g. "Full,DL").""", default_value=False, advanced=True, ), @@ -316,7 +316,7 @@ def get_graphs(self, graphs: dict, context: ExecutionContext) -> None: file.write(line + "\n") if iri == self.data_graph_iri: file.write( - f"\n<{iri}> " + f"<{iri}> " f" <{self.ontology_graph_iri}> ." ) @@ -368,7 +368,7 @@ def add_result_import(self) -> None: post(query=query) def remove_ontology_import(self) -> None: - """Add result graph import to ontology graph""" + """remove ontology graph import from output graph""" query = f""" DELETE DATA {{ GRAPH <{self.output_graph_iri}> {{ diff --git a/cmem_plugin_reason/reason_doc.md b/cmem_plugin_reason/reason_doc.md index 12a93be..a28ccf9 100644 --- a/cmem_plugin_reason/reason_doc.md +++ b/cmem_plugin_reason/reason_doc.md @@ -56,17 +56,27 @@ parameters to include inferred axiom generators: ### Validate OWL2 profiles -Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full). The ontology is annotated in the output graph. +Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full) and annotate the result graph. ### Process valid OWL profiles from input -If enabled along with the "Validate OWL2 profiles" parameter, the ontology IRI and list of valid profiles is taken from the config port input, -without validating the ontology against the profiles in the plugin. If the "Validate OWL2 profiles" parameter is enabled in the "Validate" plugin, it can be directly connected to the input -of the "Reason" plugin. +If enabled along with the "Validate OWL2 profiles" parameter, the valid profiles and ontology IRI is taken from the +config port input (parameters "valid_profiles" and "ontology_graph_iri") instead of from running the validation in the +plugin. The valid profiles input is a comma-separated string (e.g. "Full,DL").the ontology IRI and list of valid +profiles is taken from the config port input, without validating the ontology against the profiles in the plugin. If the +"Validate OWL2 profiles" parameter is enabled in the "Validate" plugin, it can be directly connected to the input of the +"Reason" plugin. +### Add ontology graph import to result graph + +Add the triple ` owl:imports ` to the output graph. + +### Add result graph import to ontology graph + +Add the triple ` owl:imports ` to the ontology graph ### Maximum RAM Percentage Maximum heap size for the Java virtual machine in the DI container running the reasoning process. -⚠️ Setting the percentage too high may result in an out of memory error. +:warning: Setting the percentage too high may result in an out of memory error. diff --git a/cmem_plugin_reason/validate_doc.md b/cmem_plugin_reason/validate_doc.md index 91e2871..055a46b 100644 --- a/cmem_plugin_reason/validate_doc.md +++ b/cmem_plugin_reason/validate_doc.md @@ -43,12 +43,15 @@ Raise an error if inconsistencies are found. If enabled, the plugin does not out ### Validate OWL2 profiles -Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full). The valid profiles are added to the output -Markdown file and the ontology is annotated in the output graph. The plugin outputs the profiles with path "valid_profiles", -and the ontology IRI with path "ontology_graph_iri". +Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full) and annotate the result graph. + +### Output entities + +Output entities. The plugin outputs the explanation as text in Markdown format on the path "markdown", the ontology IRI +on the path "ontology_graph_iri", and, if enabled, the valid OWL2 profiles on the path "valid_profiles ### Maximum RAM Percentage Maximum heap size for the Java virtual machine in the DI container running the reasoning process. -⚠️ Setting the percentage too high may result in an out of memory error. +:warning: Setting the percentage too high may result in an out of memory error.