individual_swims: Retrive Report From USA Swimming's NCAA DI Top Times Report

In warlicks/swimR: Gather College Swimming Results From USA Swimming Top Time Reports

Description

individual_swims fills out USA Swimmings Top Times report form to retrun a top time report.

Usage

individual_swims(conf, start_date = "2015-08-01", end_date = "2015-05-31",
  lcm = FALSE, scm = FALSE, scy = TRUE, top = 100,
  download_path = getwd(), read = TRUE)

Arguments

conf	a character string giving name of a Division I conference.
start_date	a character string that defines the begining of the period for the times report. It is entered as a character string in the format 'YYYY-MM-DD'.
end_date	a character string that defines the end of the period for the times report. It is entered as a character string in the format 'YYYY-MM-DD'.
lcm	logical indication if long course meter events be included in the report?. Defaults to FALSE.
scm	logical indicating if should short course meter events be included in the report. Defaults to FALSE.
scy	logical indicating if short course yard events be included in the report. Defaults to TRUE.
top	integer indicating how many swimmers should be returned in each event. Default value is top 100 times, while the maximum allowed is 500.
download_path	character sting repersenting a file directory where the returned top times report should be saved. By default it saves the file to the current working directory.
read	logical indicating if the downloaded file should be loaded into R's memory.

Details

individual_swims fills out USA Swimmings Top Times report form to retrun a top time report. The function fills out form and downloads the as .csv file without any human interaction.

To fill out the Top Times report form individual_swims() utilizes RSelenium. RSelenium requires a Selenium Server. The function automatically checks to make sure that the Selenium Server is installed. If one is not found it downloads the most recent version.

Note: the package was developed using Firefox 47.0.1 and Selenium Standalone Server 2.53.1. It is important to make sure that the server version being used is compatiable with the browser being used.

By default the function reads the downlaoded file into memory and stores it as the assigned variable name. If you select not to read the file into memory it returns the path where the file was saved.

The function automatically renames the file downloaded to confernece.csv. If a file with the name confernce.csv already exists in chosen directory, it will write over the existing file.

Value

If read = TRUE a data frame is returned. In both cases a .csv file is created in the given directory.

See Also

RSelenium

Examples

report <- individual_swims('Big Ten', start_date = '2015-09-01', end_date = '2015-10-01', read = TRUE)
report <- individual_swims('Big Ten', start_date = '2015-09-01', end_date = '2015-10-01', read = FALSE)

warlicks/swimR documentation built on May 4, 2019, 12:59 a.m.