README.md

Build Status Travis

AppVeyor Build Status AppVeyor

earthquake package in R

This is a small R package for cleaning, timelining, and mapping NOAA Significant Earthquake data.

About

This R package was originally built to satisfy the requirements of the Capstone project for the Coursera Mastering Software Development in R 5-course specialization.

Installation

To install this package to run on your system, please first install and load the devtools package. Then you may install and load this package thus:

devtools::install_github('c')
library(earthquake)

Vignette

You may read the interactive vignette at my personal blog site, at: https://github.com/DYZI/Earthquake/blob/master/vignettes/introduction.Rmd

Alternatively, read the introduction vignette using the command vignette('introduction', package = 'earthquake') after installation. However, in order to do this, you must build the vignettes when installing, using the command devtools::install_github('DYZI/Earthquake', build_vignettes = TRUE)

Review Criteria

• Your package must be hosted on GitHub repository. You will be providing the URL to your package on GitHub so that other students can evaluate your work.

• Your package must at least contain the following directories: R?, man?, tests?, vignettes?.

• Your package must at least contain the following files: .travis.yml, DESCRIPTION, LICENSE , NAMESPACE, README.md.

• Every function in your package must have a corresponding test?,

• Every function in your package must have at least one example in its documentation.

• Your package must have a vignette which provides an explanation of the purpose for your package and how it could be used. The vignette should include examples for every function that is exported in the package's NAMESPACE file.

• A [Travis badge] that says "Build Status" that is linked to your package's. Travis build should appear at the top of your README.md file on GitHub.

• Your package must be tested using Travis. There should be no errors, warnings, or notes at the end of your Travis build, and all of your tests should be run on Travis.



DYZI/Earthquake documentation built on May 7, 2019, 6:54 p.m.