Skip to content

Commit

Permalink
Fix docs structure (#398)
Browse files Browse the repository at this point in the history
  • Loading branch information
amrit110 authored Mar 8, 2023
1 parent 5e48fdb commit d582fc0
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "docs/cyclops-webpage"]
path = docs/cyclops-webpage
url = git@github.com:amrit110/cyclops-webpage.git
url = git@github.com:VectorInstitute/cyclops-webpage.git
2 changes: 1 addition & 1 deletion docs/cyclops-webpage
Submodule cyclops-webpage updated 0 files
4 changes: 2 additions & 2 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ API Reference
=============

.. toctree::
:glob:

reference/api/*
reference/api/cyclops.query.rst
reference/api/cyclops.evaluate.rst
5 changes: 1 addition & 4 deletions docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@ Tutorials

.. toctree::

tutorials/mimiciii/query_api.ipynb
tutorials/mimiciv/query_api.ipynb
tutorials/synthea/query_api.ipynb
tutorials/eicu/query_api.ipynb
tutorials_query
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,20 @@
"id": "e337389b-1cfe-4796-a846-b4e1ba5690d6",
"metadata": {},
"source": [
"# Synthea query API tutorial"
"# OMOP query API tutorial"
]
},
{
"cell_type": "markdown",
"id": "1efffc64",
"metadata": {},
"source": [
"This notebook shows examples of how to use the cyclops.query API on [Synthea](https://github.com/synthetichealth/synthea) in OMOP format.\n",
"This notebook shows examples of how to use the cyclops.query API to query EHR databases that follow the OMOP common data model. We showcase the examples on:\n",
"\n",
"* First, generate synthea data using their releases. We used [v2.7.0](https://github.com/synthetichealth/synthea/releases/tag/v2.7.0) to generate data .\n",
"* Follow instructions provided in [ETL-Synthea](https://github.com/OHDSI/ETL-Synthea) to load the CSV data into a postgres database, and perform ETL to load the data into OMOP format."
"1. [Synthea](https://github.com/synthetichealth/synthea) in OMOP format.\n",
"\n",
" * First, generate synthea data using their releases. We used [v2.7.0](https://github.com/synthetichealth/synthea/releases/tag/v2.7.0) to generate data .\n",
" * Follow instructions provided in [ETL-Synthea](https://github.com/OHDSI/ETL-Synthea) to load the CSV data into a postgres database, and perform ETL to load the data into OMOP format."
]
},
{
Expand Down
15 changes: 15 additions & 0 deletions docs/source/tutorials_query.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
query API
=========

The query API allows you to query EHR databases. It is a Python API that
that communicates with postgresql databases. It is a wrapper around the
SQLAlchemy ORM and uses SQLAlchemy query objects and functions to build
queries.


.. toctree::

tutorials/mimiciii/query_api.ipynb
tutorials/mimiciv/query_api.ipynb
tutorials/eicu/query_api.ipynb
tutorials/omop/query_api.ipynb

0 comments on commit d582fc0

Please sign in to comment.