README.md

In dloewenstein/promise: The PROMISE dataset

PROMISE

2019-06-11

Duke University Medical Center echo and ecg research database

The purpose of this package is to facilitate further research using the PROMISE database in which one finds merged clinical Echocardiography, Electrocardiography and Demographics data. You can navigate the documentation at https://dloewenstein.github.io/promise/

Disclaimer

Due to the fact that the data of this package contains PHI it’s stored securely elsewhere and is not shipped with the package.

To get access to the data contact:

• Name: Daniel Loewenstein
  • Role: auth, crea
  • Email: [e-mail]
• Name: Karin Johansson
  • Role: auth
  • Email: [e-mail]

Installation

Make sure to have either ( Box drive, [ Windows, Mac ] ) or ExpanDrive installed and setup as to being able to access the shared data via Box.com.

If you haven’t already, make sure that the devtools package is installed

install.packages("devtools")

Continue by installing promise from github with:

devtools::install_github("dloewenstein/promise")

You can also install promise from Anaconda.org with:

conda install -c dloewenstein r-promise

First time loading promise you will be prompted to start R with adminrights, this is so R gets access rights to create a symbolic link from the securely stored data accessible via Box drive or ExpanDrive to the local library folder.

Continue by running

library(promise)

# If Box drive or ExpanDrive is installed you will now have a remote location
# mapped as local folder or drive, provide the search path to function below e.g

#For interactive use
set_data_path() #Will be promted with browser Window

#Setting filepath directly
set_data_path("C:/Users/yourUserName/Box/promise/promiseData_v0.1.6.rda", .interactive = FALSE) # Only need to run once

#For updating
set_data_path(.update = TRUE)

You have now setup access to the promise data and are now able to load the data by

data(promiseData)
data(ecg)

dloewenstein/promise documentation built on Nov. 21, 2024, 6:57 p.m.