firstTimers: Find volunteers who have signed up for a program that is new...

Description Usage Arguments Value Examples

View source: R/firstTimers.R

Description

This function is the main function of the "firstTimers" application. The main steps of the program are to download a new CSV report from SignUps.com with all of the program and volunteer data, determine which volunteers have signed up for a program they have never been to, then send these volunteers an email with instructions.

Usage

1
2
firstTimers(wePath, signupComFile = NULL,
  sendVolunteerEmails = "pretend")

Arguments

wePath

The base directory for the firstTimers program. This function/program requires several input files and creates several output files. All of these files w

sendVolunteerEmails

"draft" creates the emails in the draft folder, "none" does not create or send emails.

volListFileName

Either NULL, and the program will download a new report from SignUps.com and compare it to the most recently downloaded file, or an array of two character vectors: c("oldFilePath", "newFilePath"), where the file paths are formed with file.path(wePath, signupComFile).

isSendLogEmail

TRUE sends (creates a draft) email of the log file. FALSE does not send thos email, and is mostly used only for testing.

Value

The unprocessed and untidied data.frame created when reading in the newest SignUp.com report CSV file.

Examples

1
2
3
4
5
6
7
8
# A typical run:
data1 <- firstTimers("~/Documents/DataSci/wevan")

# For debugging/testing purposes it is nice to reprocess files and, perhaps, not send any emails.
data1 <- firstTimers("~/Documents/DataSci/wevan",
    signupComFile = "archive/weVolunteerList-2017-11-15_10-03-50.csv",
    isSendLogEmail = FALSE,
    sendVolunteerEmails = "none")

BKoblinger/writersexchanger documentation built on Dec. 2, 2018, 12:18 p.m.