callAdhereR: callAdhereR.

In AdhereR: Adherence to Medications

callAdhereR.

Description

The function encapsulating all the logics that allows AdhereR to be called from any platform using the generic shell mechanism.

Usage

callAdhereR(shared.data.directory)

Arguments

shared.data.directory

A string containing the path to the directory where all the exchanged (shared) data (both input and output) is. AdhereR needs read and write access to this directory.

Details

In most cases this should not be done directly by the user, but instead used by an appropriate wrapper on the client platform. It allows transparent use of AdhereR from virtually any platform or programming language for which an appropriate wrapper is provided. For more details see the vignette describing the included reference Python 3 wrapper.

Value

This function displays any messages to the console, tries to also write them to the Adherer-results.txt file in the shared.data.directory directory, and, when finished, forces R to quit with a given shell error code:

• 0 The processing ended without major errors;

• 1 General error (hopefully there are messages in the Adherer-results.txt file;

• 10 The directory shared.data.directory does not exit;

• 11 AdhereR does not have read access to the shared.data.directory directory;

• 12 AdhereR does not have write access to the shared.data.directory directory;

• 13 issues with the parameters file parameters.log;

• 14 issues with the data file dataset.csv;

• 15 plotting issues;

• 16 interactive plotting issues;

• 17 issues exporting the results.

AdhereR documentation built on July 5, 2022, 5:08 p.m.