README.md

Peer-graded Assignment: Building an R Package

The purpose of this assessment is for you to combine your skills of creating, writing, documenting, and testing an R package with releasing that package on GitHub. In this assessment you'll be taking the R files from Week 2's assessment about documentation and putting that file in an R package.

For this assessment you must

write a vignette to include in your package using knitr and R Markdown
write at least one test written using testthat
put your package on GitHub
set up the repository so that the package can be checked and built on Travis
Once your package has built on Travis and the build is passing with no errors, warnings, or notes you should add your Travis badge to the README.md file of your package repository.

Review criteria

For this assignment you'll submit a link to the GitHub repository which contains your package. This assessment will ask reviewers the following questions:

Does this package contain the correct R file(s) under the R/ directory?
Does this package contain a man/ directory with corresponding documentation files?
Does this package contain a vignette which provides a meaningful description of the package and how it should be used?
Does this package have at least one test included in the tests/ directory?
Does this package have a NAMESPACE file?
Does the README.md file for this directory have a Travis badge?
Is the build of this package passing on Travis?
Are the build logs for this package on Travis free of any errors, warnings, or notes?


ammhd/farsFinal documentation built on Sept. 5, 2017, 12:03 a.m.