README.md
In IRBLleida/wvven: Wrong Variable Value Email Notification

wvven

The Wrong Variable Value Email Notification package is an interface to send emails via SendGrid.

The goal of the package is to provide an easy and clean way to send a notification email alerting the responsible of the dataset of a wrong value in a patient's variable.

This package uses Sendgrid's template system to send a styled email, and therefore you will need to provide both an API key to authenticate with SendGrid an a template ID.

The devtools package is needed to install this package directly from GitHub. If you don't have it installed, you can install it with:

install.packages("devtools")

Once it has been installed:

library(devtools)
install_github("IRBLleida/wvven")

The wvven package requires two envirnment variables to be defined:

SENDGRID_KEY: The API key to send emails via SendGrid v3 web API.
SENDGRID_TEMPLATE: The ID of the SendGrid template that will be used.

You should have a .Renviron file in your home directory that looks like:

SENDGRID_KEY=<API_KEY>
SENDGRID_TEMPLATE=<TEMPALTE_ID>

To find your home path you can execute the following R script:

normalizePath("~/")

To create the .Renviron file directly from R (replacing YOUR-API-KEY and TEMPLATE-ID for the real values):

cat("SENDGRID_KEY=YOUR-API-KEY\nSENDGRID_TEMPLATE=TEMPLATE-ID",
    file=file.path(normalizePath("~/"), ".Renviron"),
    append=TRUE)

You will need to restart your R session before using the package or R won't detect the newly created environment variables. If you are using R Studio, you can execute:

.rs.restartR()

There is only one function, notify(), which will send the notification email.

library(wvven)
notify("PATIENT_ID", "VARIABLE", "WRONG VALUE", "RECEIVER_EMAIL@SOMETHING.TEST", "ADDITIONAL COMMENTS.")

Five parameters should be provided to the notify() function: - PATIENT: The identifier of the patient. - VARIABLE: The variable that has an incorrect value. - VALUE: The current incorrect value of the patient's variable. - EMAIL: The email address of the person that will be notified (usually the provider of the dataset). - COMMENTS: Any additional comments that should be included in the notification email.

This is how a sample email looks like: Sample email result