Build Status

knitr::opts_chunk$set(echo = TRUE)

Description

A package that provides patient data evaluation algorithm for the START and STOPP criteria. The patient data are parsed and their ids are classified based on whether the meet the conditions or not for each START and STOPP criterion.

The package exports excel files that contains the patient ids and their status (1: if they fulfill the conditions for the criterion, 0: if they do not fulfill the conditions for the criterion and 2: if they have missing data). Furthermore if there are missing data on the input data the excel file specifies the column name of the input excel file that contains missing data.

Till now the following START and STOPP criteria have been incorporated in the package.

START

STOPP

Installation

The package is still under active development and has not been submitted to the CRAN yet.

You can install the StartStopp package from GitHub repository as follows:

Installation using R package devtools:

install.packages("devtools")
devtools::install_github("agapiospanos/StartStopp")

Input data format

I will soon provide an excel file as a template for the input data format.

Basic usage examples

Provided that you have the input data in the format specifed above you can use the package by calling any of the criteria functions. For example to evaluate the data for the STOPP B6 criterion you can call the following function. Calling this function, a popup window will appear to choose the excel file that contains the patient data. Then another popup window will be displayed to choose a folder that the excel file will be exported.

STOPP_B6()

You can also get a single excel file for all the STOPP or START criteria using the commands below:

STARTall()
STOPPall()

Advanced usage examples

You can exclude some criteria from running when calling STARTall() and STOPPall() functions by using the exclude argument. Use a vector in the form shown below to specify the criteria you want to exclude. NOTE: You have to use capital letters in the vector for the exclude argument as shown below.

STOPPall(exclude = c("B12", "G4"))

You can also make the STARTall() and STOPPall() functions export single excel files for each criterion. Just add the single_excel = FALSE argument as shown below:

STOPPall(single_excel = FALSE)

You can avoid all the popup windows for choosing the export path and the excel file to read data from. Just specify them using the below arguments. This arguments work for a single criterion as well as for the STARTall() and STOPPall() functions.

STOPP_B6(path = "~/patient_data.xlsx", export_data_path="~/Desktop")
STOPPall(path = "~/patient_data.xlsx", export_data_path="~/Desktop")
STARTall(path = "~/patient_data.xlsx", export_data_path="~/Desktop")

You can evaluate multiple START or STOPP criteria at once using the STARTselected and STOPPselected criteria. All the arguments of STARTall and STOPPall function also apply to the STARTselected and STOPPselected. You must provide the selected START and STOPP criteria in a vector form using the selected argument. NOTE: You have to use capital letters in the vector for the selected argument as shown below.

STOPPselected(selected=c("B13", "B1", "M1"))
STARTselected(selected=c("A2", "E5", "E7"))


agapiospanos/StartStopp documentation built on Jan. 5, 2021, 4:41 p.m.