health_check: Send email to administrator if a failure of epitweetr is...

View source: R/check.R

health_checkR Documentation

Send email to administrator if a failure of epitweetr is detected

Description

It validates if epitweetr is not collecting tweets, aggregating tweets or not calculating alerts

Usage

health_check(send_mail = TRUE, one_per_day = TRUE)

Arguments

send_mail

Boolean. Whether an email should be sent to the defined administrator, default: TRUE

one_per_day

Boolean. Whether a limit of one email per day will be applied, default: TRUE

Details

This function sends an email to the defined administrator if epitweetr is not collecting tweets, aggregating tweets or not calculating alerts

Value

A list of health check errors found

Examples

if(FALSE){
   #importing epitweetr
   library(epitweetr)
   message('Please choose the epitweetr data directory')
   setup_config(file.choose())
   #sending the email to the administrator if epitweetr components are not properly working
   health_check()
}

epitweetr documentation built on Nov. 16, 2023, 5:07 p.m.