search

CareEvolution / mdh-data-guide

MIT License
0 stars 0 forks source link

readme

MyDataHelps Data Guide

This repository contains a set of tutorials and reference examples to help analysts and data scientists learn how to use the MyDataHelps Export Database to analyze data collected by a MyDataHelps project.

The MyDataHelps Export Database is a hosted data store that is managed by CareEvolution and provides access to all data that has been exported from a MyDataHelps project. Learn more about what the Export Database is, and how it can provide access to your data assets with this summary and video introduction in the MyDataHelps User Guide.

This repository is organized into two main sections:

Getting Started with Example Notebooks

Try out the example notebooks to interpret and model your MyDataHelps data using Python and Pandas.

  1. Clone this repository.
  2. Install Python (if you do not already have Python 3.9 or later).
  3. There are several environments to run Jupyter notebooks. If you do not already have a preferred solution set up, you can run the following command to install Jupyter Lab. Learn more about Jupyter notebooks and installation options at jupyter.org:
pip install jupyterlab

Once installed, run the following command to start Jupyter Lab:

jupyter lab
  1. Gather Your Export Database Configuration Settings and Credentials

To obtain the configuration settings for your project's Export Database, open MyDataHelps Designer and navigate to the Settings tab for your project. Click Export Explorer. The External Applications tab will provide the required configuration settings that will be used in the example notebooks.

Each notebook has a cell that should be updated with the settings that you obtain for your project.

Follow the instructions on the External Applications tab to place your credentials in your local AWS credentials file. This process ensures your credentials will never be saved in files that are managed by this repository.

Getting Started with Example Queries

Try out the example queries to explore and transform your MyDataHelps data using SQL.

To run these queries:

  1. Sign into MyDataHelps Designer.
  2. Open your project settings.
  3. Select Export Explorer.
  4. Paste the query into the query window and run it.