Merge pull request #45 from CDU-data-science-team/44-vignette

Vignette for year_date()

.gitignore

@@ -4,3 +4,4 @@
 .httr-oauth
 .DS_Store
 docs
+inst/doc

DESCRIPTION

@@ -15,6 +15,7 @@ LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.2
 Suggests: 
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Imports: 
@@ -38,3 +39,4 @@ Remotes:
     mitchelloharawild/icons,
     gadenbuie/xaringanExtra,
     nhs-r-community/nhsrtheme
+VignetteBuilder: knitr

vignettes/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.R

vignettes/date_helper.Rmd

@@ -0,0 +1,36 @@
+---
+title: "date_helper"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{date_helper}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(nottshcMethods)
+library(NHSRdatasets)
+```
+
+# ONS Mortality
+
+Using the {NHSRdatasets} package and particularly the ons_mortality dataset, this finds the earliest and latest years in the dataset, useful for showing or referring to the date range in a dataset.
+
+The function works with date, integer and character formats if the date is in the format yyyy-mm-dd, for example: 
+
+The ons_mortality dataset is from `r year_date(ons_mortality, date, type = "earliest")` to `year_date(ons_mortality, date, type = "latest")`
+
+```{r}
+
+year_date(ons_mortality, date, type = "earliest")
+year_date(ons_mortality, date, type = "latest")
+
+```
+