R/eq_clean.R

In tcoopermont/eqtools: Earthquake Tools

library(dplyr)
library(tools)
#' eq_clean_data
#' 
#' This is a function the converts the latitude and longitude from NOAA earthquake data from 
#'    character to numeric and creates date column from YEAR,MONTH,DAY.
#' @param adf a dataframe containing NOAA earthquake data
#'
#' @return This function returns a dataframe with latitude and longitude columns as numeric type
#'    and a  additional column date
#'
#' @examples
#' \dontrun{
#' eq_clean_data(mydata)
#' }
#'
#' @importFrom dplyr mutate
#'
#' @export
eq_clean_data <- function(adf) {
  dplyr::mutate_(adf, LATITUDE =  ~ as.numeric(LATITUDE),
              LONGITUDE = ~ as.numeric(LONGITUDE),
              DATE = ~ as.Date(paste(YEAR,MONTH,DAY,sep="-"),"%Y-%m-%d") 
        )
}

#' eq_clean_location
#' 
#' This is a function the converts the location_name from NOAA earthquake data from uppercase to title case and remove the country from location_name. (removes everything up to the last colon character.)
#' @param adf a dataframe containing NOAA earthquake data
#'
#' @return This function returns a dataframe with location_name column as formated as title case without the country name. 
#'
#' @examples
#' \dontrun{
#' eq_clean_location(mydata)
#' }
#'
#' @importFrom dplyr mutate
#'
#'
#' @importFrom tools toTitleCase
#'
#' @export
eq_clean_location <- function(adf) {
  dplyr::mutate_(adf,LOCATION_NAME = ~ tools::toTitleCase(tolower(
             sub("^.+:\\s+" ,"",LOCATION_NAME,perl = TRUE))))

}