In ineszz/fars: fars package assignment for 4th week of the coursera JH

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

fars package built for JH course

The goal of fars is to test building R packages knowedge.

This vinette is writen for the package fars as part of week 4 assignment of the coursera course "R packages". The aim of this is to describe the functions in the package and their use cases. The packages consists of 5 main functions:

Installation

[TBD] You can install the released version of fars from CRAN with:

install.packages("fars")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("ineszz/fars")

Example

This is a basic example which shows you how to solve a common problem:

library(fars)
## basic example code

make_filename(year)
e.g. make_filename(2013)

fars_read(filename) e.g. fars_read("accident_2013.csv.bz2")

fars_read_years(years)
e.g. fars_read_years(c(2013,2014,2015))

fars_summarize_years(years) e.g. fars_summarize_years(c(2013,2014,2015))

fars_map_state(state.num, year) e.g. fars_map_state(1,2013)

Peer-graded Assignment

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/ with directory 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 badge?
• Are the build logs for this package on Travis badge free of any errors, warnings, or notes?

Please, follow the links on Review Criteria.

ineszz/fars documentation built on Jan. 24, 2021, 9:18 a.m.