read_dMeasureModules: read_dMeasureModules

In DavidPatShuiFong/dMeasure: case finding in the EMR (Best Practice)

read_dMeasureModules

Description

discover available dMeasure module packages

Usage

dMeasureModules(dMeasure_obj)

Arguments

none

Details

dMeasure's function is extended by modules, such as dMeasureAppointments, dMeasureMedication, dMeasureQIM and dMeasureBilling

read_dMeasureModules detects which of these modules (R packages) have been installed and reads the details.

• dMeasure modules all start with the prefix dMeasure

• dMeasure modules all export the function dMeasureIntegration

  • the function dMeasureIntegration (and others) can return details of the module package

    • typically Package, Provides, Requires, moduleID

    • Package - the module package name

    • Provides - the functionality the module package provides

    • Requires - the dependencies of the module package. Can be just dMeasure, but also can be other modules

    • moduleID - the ID when the server component of the module is executed. can be multiple IDs

      • can be a list of IDs with optional ⁠$extraargs⁠ extra arguments to pass to server component of module

    • configID - optional ID of server component of configuration panel

• dMeasure modules can provide additional information

  • optional sidebarmenuPriority function helps arrange position of module in left sidebar.

read_dMeasureModules stores the results in ⁠$dMeasureModules⁠ and returns the dataframe + ⁠$dMeasureModules⁠ is used in methods such as ⁠$open_configuration_db⁠, and so read_dMeasureModules may need to be called early in the work-flow if the configuration information is required.

Value

a dataframe providing module details e.g. Package name

DavidPatShuiFong/dMeasure documentation built on Aug. 2, 2024, 11:45 p.m.