search

dr-consulting / ibi_VizEdit

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

Create CRAN-compliant documentation for the IBI VizEdit #66

Open matgbar opened 5 years ago

matgbar commented 5 years ago

SCENARIO: ALEX or LOGAN is using IBI_VizEdit and they need assistance in understanding what information they can pass to the application when they launch the application

GIVEN: ALEX or LOGAN has a question about the properties of the IBI_VizEdit::run_app() function

WHEN: They run ?IBI_VizEdit::run_app()

THEN: The complete documentation for the function should be displayed for their review

AND: This same information should be reflected in a .pdf manual that conforms to CRAN documentation standards

matgbar commented 4 years ago

This story coincides with the work being done in #65. Once #65 is complete, the main task here will be to perform a full audit of the documentation and identifying any remaining gaps in terms of making the package CRAN-compliant.