R/get_data.R

In ctaber/NOAA: Turn NOAA Data Into Earthquake Visualizations

#' Read in Data
#'
#' This function takes a country name in all capitals, a start date as a string in 'YYYY-MM-DD' format, and optionally an end date in the same format, read in the earthquake data, cleans it, and turns a filtered cleaned dataframe.
#'
#' @param filename Name of file to read in. Defaults to 'earthquakes.tsv.gz' data contained internally in package.
#'
#' @param country A country name in all capital letters as a sting, eg. 'MEXICO', or a vector of country names, eg. c('MEXICO','USA')
#'
#' @param start_date A date as a string in 'YYYY-MM-DD' format to filter observations for
#'
#' @param end_date An optional paramater, a date as a string in 'YYYY-MM-DD' format to filter observations for. Defaults to todays date if not overridden.
#'
#' @importFrom lubridate today ymd
#'
#' @importFrom dplyr filter %>%
#'
#' @importFrom readr read_delim
#'
#' @details This function reads in an earthquake dataset provided with the package, cleans and formats the data, then filters for a country or countries, then returns a tbl_df data.frame
#'
#'@return tbl_df data.frame
#'
#'
#' @examples
#' \dontrun{eq_get_data(filename = system.file('extdata', 'earthquakes.tsv.gz', package = 'NOAA'), country = c('MEXICO','USA'), start_date = '2001-01-01', end_date = '2003-01-01')}
#' \dontrun{eq_get_data(filename = system.file('extdata', 'earthquakes.tsv.gz', package = 'NOAA'), country = 'MEXICO', start_date = '2001-01-01')}
#'
#' @export

eq_get_data<- function(filename = system.file('extdata', 'earthquakes.tsv.gz', package = 'NOAA'), country, start_date, end_date = lubridate::today()){
   data <- readr::read_delim(filename, delim = '\t')
   data %>%
    eq_clean_data() %>%
    dplyr::filter(COUNTRY %in% country & DATE >= lubridate::ymd(start_date) & DATE<= lubridate::ymd(end_date))%>%
    eq_location_clean()
}