Skip to content

Commit

Permalink
adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
hrshdhgd committed Feb 13, 2024
1 parent cd54918 commit 0a084a1
Showing 1 changed file with 51 additions and 48 deletions.
99 changes: 51 additions & 48 deletions docs/technical_docs/writers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,67 +5,70 @@ This module contains functions for serializing SSSOM mapping set dataframes to v
### Writers

.. list-table::
:header-rows: 1
:widths: 15 15 70
:header-rows: 1

* - Writer Function
- Output Format
- Description
* - `write_table`
- TSV
- This function writes a `MappingSetDataFrame` object to a file as a table.
* - `write_owl`
- OWL
- This function writes a `MappingSetDataFrame` object to a file as OWL.
* - `write_ontoportal_json`
- Ontoportal JSON
- This function writes a `MappingSetDataFrame` object to a file as the ontoportal mapping JSON model.
* - `write_fhir_json`
- FHIR JSON
- This function writes a `MappingSetDataFrame` object to a file as FHIR ConceptMap JSON.
* - `write_json`
- JSON
- This function writes a `MappingSetDataFrame` object to a file as JSON.
* - `write_rdf`
- RDF
- This function writes a `MappingSetDataFrame` object to a file as RDF.
* - Writer Function
- Output Format
- Description
* - `write_table`
- TSV
- This function writes a `MappingSetDataFrame` object to a file as a table.
* - `write_owl`
- OWL
- This function writes a `MappingSetDataFrame` object to a file as OWL.
* - `write_ontoportal_json`
- Ontoportal JSON
- This function writes a `MappingSetDataFrame` object to a file as the ontoportal mapping JSON model.
* - `write_fhir_json`
- FHIR JSON
- This function writes a `MappingSetDataFrame` object to a file as FHIR ConceptMap JSON.
* - `write_json`
- JSON
- This function writes a `MappingSetDataFrame` object to a file as JSON.
* - `write_rdf`
- RDF
- This function writes a `MappingSetDataFrame` object to a file as RDF.

The `get_writer_function()` function can be used to obtain the appropriate writer function based on the desired output format.

### Converters

.. list-table::
:header-rows: 1
:widths: 15 15 70
:header-rows: 1

* - Converter Function
- Output Format
- Description
* - `to_owl_graph`
- OWL graph
- This function converts a `MappingSetDataFrame` object to OWL in an RDF graph.
* - `to_rdf_graph`
- RDF graph
- This function converts a `MappingSetDataFrame` object to an RDF graph.
* - `to_fhir_json`
- FHIR JSON
- This function converts a `MappingSetDataFrame` object to a JSON object.
* - `to_json`
- JSON
- This function converts a `MappingSetDataFrame` object to a JSON object.
* - `to_ontoportal_json`
- Ontoportal JSON
- This function converts a `MappingSetDataFrame` object to a list of ontoportal mapping JSON objects.
* - Converter Function
- Output Format
- Description
* - `to_owl_graph`
- OWL graph
- This function converts a `MappingSetDataFrame` object to OWL in an RDF graph.
* - `to_rdf_graph`
- RDF graph
- This function converts a `MappingSetDataFrame` object to an RDF graph.
* - `to_fhir_json`
- FHIR JSON
- This function converts a `MappingSetDataFrame` object to a JSON object.
* - `to_json`
- JSON
- This function converts a `MappingSetDataFrame` object to a JSON object.
* - `to_ontoportal_json`
- Ontoportal JSON
- This function converts a `MappingSetDataFrame` object to a list of ontoportal mapping JSON objects.

### Support Methods

.. list-table::
:header-rows: 1
:widths: 25 75
:header-rows: 1

* - Method
- Description
* - `_get_separator`
- Returns the appropriate separator character for the specified table format.
* - `_inject_annotation_properties`
- Injects annotation properties into an RDF graph.
* - Method
- Description
* - `_get_separator`
- Returns the appropriate separator character for the specified table format.
* - `_inject_annotation_properties`
- Injects annotation properties into an RDF graph.

### Writing Tables

Expand Down

0 comments on commit 0a084a1

Please sign in to comment.