R_capstone_final: software.dev.capstone

# #Andrew Spewak
# #Mastering Software Development in R Capstone
#
# ---
#   title: "R Capstone"
# date: "September 28, 2020"
# output: rmarkdown::capstone_vignette
# vignette: >
#   %\VignetteIndexEntry{Overview of the capstone package}
# %\VignetteEngine{knitr::rmarkdown}
# %\VignetteEncoding{UTF-8}
# ---
#
#   This is an overview of an R package that visualizes charts and interactive maps of NOAA earthquake data. Its purpose is to provide
#   easy and quick analysis of earthquake data across the world over the last several thousand years.
#
# ```{r, echo=FALSE, message=FALSE}
# library(software.dev.capstone)
# library(readr)
# library(tidyr)
# library(dplyr)
# library(lubridate)
# library(stringr)
# library(ggplot2)
# library(grid)
# library()
# ```
#
# ## Package Content
#
# The package is composed of the following elements or data handling routines:
#
# eq_clean_data: This function reads in earthquake data and ouptuts a cleaned data file
# eq_location_clean: This function cleans the location_name variable of the earthquake data, nested in the eq_clean_data function
# geom_timeline: This function plots a timeline of earthquakes
# geom_timeline_labels:This function creates labels for the timeline of earthquakes
# eq_map: This function creates a map showing the location of earthquakes
# eq_create_label: This function creates pop-up labels for the map of earthquakes
#
# ## Required Packages
#
# The following packages are loaded and required by the package.
#
# ```{r Package Loading}
# library(software.dev.capstone)
# library(readr)
# library(tidyr)
# library(dplyr)
# library(lubridate)
# library(stringr)
# library(ggplot2)
# library(grid)
# library()
# ```
#
# ## eq_clean_data
#
# ```{r eq_clean_data function, eval=FALSE}
# eq_clean_data("signif.txt")
# ```
#
# ## eq_location_clean
#
# ```{r eq_location_clean function, eval=FALSE}
# eq_location_clean(intermediate_data)
# ```
#
# ## geom_timeline
#
# ```{r geom_timeline function, eval=FALSE}
# ggplot() + geom_timeline(aes(x = DATE, y = COUNTRY, color = TOTAL_DEATHS)```
#
# ## geom_timeline_labels
#
# ```{r geom_timeline_labels function, eval=FALSE}
# ggplot() + geom_timeline(aes(x = DATE, y = COUNTRY, color = TOTAL_DEATHS) +
#                            geom_timeline_label(aes(x = DATE, y = COUNTRY, magnitude = EQ_PRIMARY, label = LOCATION_NAME, n_max = 5))
# ```
#
# ## eq_map
#
# ```{r eq_map function, eval=FALSE}
# readr::read_delim("earthquakes.tsv.gz", delim = "\t") %>% eq_clean_data() %>% dplyr::filter(COUNTRY == "USA") %>% q_map(annot_col = "DATE")```
#
#
# ## eq_create_label
#
# ```{r eq_create_label function, eval=FALSE}
# readr::read_delim("earthquakes.tsv.gz", delim = "\t") %>% eq_clean_data() %>% dplyr::filter(COUNTRY == "USA") %>% dplyr::mutate(popup_text = eq_create_label(.)) %>% eq_map(annot_col = "popup_text")
# ```
#