Author(s): Lily Bessette, [email protected]
Contributor(s): Joe Buckley, [email protected]
Updated 2020-12-22
Python version 3.7.x. Development using venv, see documentation.
See requirements.txt for external dependencies.
The parent directory of this code repository should contain 3 folders containing data to be read in:
000_PatientData
- contains all patient data used in prediction modeling and patient history (baseline demographics, observed feedback, other attributes for the program to continually update)
- exists as pickle of data for each day following full completion of reward calls to Personalizer (to update resulting adherence from yesterday) and rank calls to Personalizer (to find SMS message to send today)
- named "YYYY-MM-DD_pillsy" with date prepended in format as indicated
- date used is of when data is generated by program (i.e. today is exported at program completion, yesterday is loaded in for program)
000_REDCap
- contains demographic patient data
- exists as csv of data exported daily from REDCap
- named "YYYY-MM-DD_redcap" with date prepended in format as indicated
- date used is of when data is to be updated in patient dictionary (i.e. today)
000_Pillsy
- contains open/close event data from patient electronic pill bottle
- exists as csv of data for each day
- named "YYYY-MM-DD_pillsy" with date prepended in format as indicated
- date used is of when data is generated by pill bottle users (i.e. yesterday)
Likewise, the control group should have the following set of folders with file naming conventions as above:
000_PatientDataControl
- with naming convention: "YYYY-MM-DD_pt_data_control"
000_REDCapControl
- with naming convention: "YYYY-MM-DD_redcap_control"
The parent directory should also have these folders for the program to export to:
000_SMS_TO_SEND
- contains all SMS messaging history generated from the decisions of the rank calls to Personalizer
- also contains indicators for exposed and control patients for number of consecutive possibly disconnected days
- For a particular SMSHistory file
- exists as csv of data for each day
- named "YYYY-MM-DD_sms_history" with date prepended in format as indicated
- date used is of when data is to generated from patient dictionary (i.e. today)
000_RewardData
- contains all reward_updates generated from the computation of adherence between rank calls from the Pillsy data
- these reward_updates are the reward calls that we make to Personalizer to indicate how well it predicted an appropriate SMS message based on a patient's medication adherence from the last run to midnight
- For a particular RewardData file
- exists as csv of data for each day
- named "YYYY-MM-DD_reward_updates" with date prepended in format as indicated
- date used is of when reward data is generated from computation from Pillsy data and patient dictionary and sent to Personalizer (i.e. today)
000_RankData
- contains all context features sent to Personalizer via rank calls and the resulting ranked actions with their corresponding probabilities
- these context are the reward calls that we make to Personalizer to indicate how well it predicted an appropriate SMS message based on a patient's medication adherence from the last run to midnight
- For a particular RankData file
- exists as csv of data for each day
- named "YYYY-MM-DD_rank_log" with date prepended in format as indicated
- date used is of when rank data is generated from computation from Pillsy data and combined with updated REDCap data in the patient dictionary and sent to Personalizer (i.e. today)
_ProgramLog
- contains a log from running the program to record error messages and program status
- exists as txt file for each daily run of the program
- named "YYYY-MM-DD_RL_Personalizer_log.txt" with date prepended in format as indicated
The parent directory should also have these folders for the program to read unchanging data from:
_SMSChoices
- contains one file sms_choices.csv
- this is the link between the numeric codes associated with text messages to be sent and the texts themselves
.keys
- contains one file azure-personalizer-key.txt
- this is the file that contains the Personalizer client key and endpoint for instantiation of a Personalizer client at run time