README.md

In ekawabata/TheCapstoneProject: Title: Useful functions for studying and visualising data from the U.S. National Oceanographic and Atmospheric Administration (NOAA)

The TheCapstoneProject package

The goal of the TheCapstoneProject package is to build a software package that can be used to work with the NOAA Significant Earthquakes dataset. This dataset has a substantial amount of information embedded in it that may not be immediately accessible to users without knowledge of the intimate details of the dataset or of R. This package provides the tools for processing and visualizing the data so that they may extract some use out of the information embedded within.

Installation

You can install the released version of TheCapstoneProject from GitHub with:

devtools::install_github("ekawabata/TheCapstoneProject")
#>          checking for file 'C:\Users\fa20506\AppData\Local\Temp\RtmpIl0i9i\remotes4c6c47ec2490\ekawabata-TheCapstoneProject-633ffc5/DESCRIPTION' ...     checking for file 'C:\Users\fa20506\AppData\Local\Temp\RtmpIl0i9i\remotes4c6c47ec2490\ekawabata-TheCapstoneProject-633ffc5/DESCRIPTION' ...   v  checking for file 'C:\Users\fa20506\AppData\Local\Temp\RtmpIl0i9i\remotes4c6c47ec2490\ekawabata-TheCapstoneProject-633ffc5/DESCRIPTION'
#>       -  preparing 'TheCapstoneProject':
#>    checking DESCRIPTION meta-information ...     checking DESCRIPTION meta-information ...   v  checking DESCRIPTION meta-information
#>       -  checking for LF line-endings in source and make files and shell scripts
#>       -  checking for empty or unneeded directories
#>       -  building 'TheCapstoneProject_0.1.0.tar.gz'
#>      
#> 
library(TheCapstoneProject)

The functions

eq_clean_data

The eq_clean_data function takes a data from the NOAA website and returns a clean data frame.

eq_location_clean

The eq_location_clean() function adds a LOCATION_NAME column to the data frame, which will be needed for annotating visualisations for the geom_timeline_label() and eq_create_label() functions.

geom_timeline

The geom_timeline() function takes a cleaned data set as an argument and plots a timeline of earthquakes for a specified date range.

geom_timeline_label

The geom_timeline_label() function also plots a timeline of earthquakes and adds annotations.

eq_map

The eq_map() function takes a cleaned data set as an argument and displays earthquakes it in an interactive map.

eq_create_label

The eq_create_label() function takes a cleaned data set as an argument and creates an HTML label that can be used as annotation text in an interactive map.

ekawabata/TheCapstoneProject documentation built on June 27, 2020, 7:58 a.m.