dr-consulting / ibi_VizEdit

Programming Components for Modeling & Editing Heart Rate Data
0 stars 3 forks source link

Re-structure IBI_VizEdit as an R Package #63

Open matgbar opened 5 years ago

matgbar commented 5 years ago

CONTEXT: IBI_VizEdit was initially designed to offer an open-source tool for processing and manually editing cardiac data obtained via photoplethysmography. These files came from a single lab, and the program is designed exclusively with that lab's file structure and needs in mind.

CURRENT SITUATION: Installation and setup of IBI_VizEdit is not very straightforward. It requires working through the installation guide, and from a user experience this could be much improved if it were re-structured as an R package.

DESIRED GOAL: When this epic is complete, IBI_VizEdit will have changed as follows:

  1. ALEX will be able to download and install IBI_VizEdit from an R console using the devtools package
  2. ALEX and LOGAN will be able to launch IBI_VizEdit from an R console using the command IBI_VizEdit::run_app()
  3. ALEX and LOGAN will have access to improved documentation that conforms to CRAN documentation standards for the specific functions that can be called
  4. ALEX and LOGAN will be able to use IBI_VizEdit with a wider range of file formats and project structures