added test and vignette

tmss1 · Jul 5, 2022 · d04c59b · d04c59b
1 parent 0790a5f
commit d04c59b
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .Ruserdata
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -9,3 +9,7 @@ Description: More about what it does (maybe more than one line)
 License: What license is it under?
 Encoding: UTF-8
 LazyData: true
+Suggests: 
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr
diff --git a/inst/tests/tests.R b/inst/tests/tests.R
@@ -0,0 +1,3 @@
+# Test make_filename
+testthat::expect_equal(make_filename(2015),"accident_2015.csv.bz2")
+
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/make_filename.Rmd b/vignettes/make_filename.Rmd
@@ -0,0 +1,23 @@
+---
+title: "make_filename"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{make_filename}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+The `make_filename` function creates an "accident_year.csv.bz2" file name given the year entered by the user. 
+
+```{r setup}
+library(fars)
+fname <- make_filename(2015)
+fname
+```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Test make_filename
		testthat::expect_equal(make_filename(2015),"accident_2015.csv.bz2")