From 4c962845ca1ae8a49136a72c8c9e05d86f9fbf4e Mon Sep 17 00:00:00 2001
From: Damon Morris <d.j.morris@sheffield.ac.uk>
Date: Tue, 15 Aug 2023 16:38:36 +0100
Subject: [PATCH] update site

---
 public/articles/lfsclean.html | 28 ++++++++++++++++++++++++----
 public/pkgdown.yml            |  2 +-
 vignettes/lfsclean.Rmd        | 21 ++++++++++++++++++---
 3 files changed, 43 insertions(+), 8 deletions(-)

diff --git a/public/articles/lfsclean.html b/public/articles/lfsclean.html
index 149a2cf..637673f 100644
--- a/public/articles/lfsclean.html
+++ b/public/articles/lfsclean.html
@@ -100,14 +100,22 @@ <h1 data-toc-skip>Package use</h1>
 read data function for each individual year contained within a global
 cleaning function which applies each cleaning function in turn. The
 collection of global cleaning functions for each year are then wrapped
-in a function to combine years of data.</p>
+in a function to combine years of data into a single data table for
+output.</p>
+<div class="section level3">
+<h3 id="quarterly-cross-sectional-datasets">Quarterly cross-sectional datasets<a class="anchor" aria-label="anchor" href="#quarterly-cross-sectional-datasets"></a>
+</h3>
 <p>The <code><a href="../reference/lfsclean.html">lfsclean()</a></code> wrapper function is used to process
 multiple quarterly cross-sectional LFS data files into a single dataset
 of cleaned variables.</p>
 <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
-<code class="sourceCode R"><span><span class="co">#### read in and clean raw data using the package</span></span>
+<code class="sourceCode R"><span><span class="co">## Load the package and other useful libraries</span></span>
+<span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">lfsclean</span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://tidyverse.tidyverse.org" class="external-link">tidyverse</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/jrnold/ggthemes" class="external-link">ggthemes</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://zoo.R-Forge.R-project.org/" class="external-link">zoo</a></span><span class="op">)</span></span>
 <span></span>
-<span><span class="co">####################</span></span>
 <span><span class="co">## input arguments</span></span>
 <span></span>
 <span><span class="va">root</span>  <span class="op">&lt;-</span> <span class="st">"C:/"</span></span>
@@ -128,6 +136,10 @@ <h1 data-toc-skip>Package use</h1>
 <span>                     keep_vars <span class="op">=</span> <span class="va">keep_vars</span>,</span>
 <span>                     complete_vars <span class="op">=</span> <span class="va">complete_vars</span>,</span>
 <span>                     deflator <span class="op">=</span> <span class="va">deflator</span><span class="op">)</span></span></code></pre></div>
+</div>
+<div class="section level3">
+<h3 id="longitudinal-datasets">Longitudinal datasets<a class="anchor" aria-label="anchor" href="#longitudinal-datasets"></a>
+</h3>
 <p>The <code><a href="../reference/lfsclean_5q.html">lfsclean_5q()</a></code> wrapper function is used to process
 the raw five-quarter longitudinal data. The arguments are simular to
 those used for the quarterly data cleaning function. <code>year</code>
@@ -137,7 +149,14 @@ <h1 data-toc-skip>Package use</h1>
 in January-March, April-June, July-September, and October-December of
 2020.</p>
 <div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
-<code class="sourceCode R"><span><span class="co">## input arguments</span></span>
+<code class="sourceCode R"><span><span class="co">## Load the package and other useful libraries</span></span>
+<span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">lfsclean</span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://tidyverse.tidyverse.org" class="external-link">tidyverse</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/jrnold/ggthemes" class="external-link">ggthemes</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://zoo.R-Forge.R-project.org/" class="external-link">zoo</a></span><span class="op">)</span></span>
+<span></span>
+<span><span class="co">## input arguments</span></span>
 <span></span>
 <span><span class="va">root</span>  <span class="op">&lt;-</span> <span class="st">"U:/"</span></span>
 <span><span class="va">file</span>  <span class="op">&lt;-</span> <span class="st">"ManWin/My Documents/Datasets/Labour Force Survey/longitudinal/tab"</span></span>
@@ -155,6 +174,7 @@ <h1 data-toc-skip>Package use</h1>
 <span>                        ages <span class="op">=</span> <span class="va">ages</span>,</span>
 <span>                        keep_vars <span class="op">=</span> <span class="va">keep_vars</span>,</span>
 <span>                        complete_vars <span class="op">=</span> <span class="va">complete_vars</span><span class="op">)</span></span></code></pre></div>
+</div>
   </div>
 
   <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
diff --git a/public/pkgdown.yml b/public/pkgdown.yml
index de168b2..d610398 100644
--- a/public/pkgdown.yml
+++ b/public/pkgdown.yml
@@ -6,7 +6,7 @@ articles:
   codebook: codebook.html
   employment-and-underemployment: employment-and-underemployment.html
   lfsclean: lfsclean.html
-last_built: 2023-08-15T15:33Z
+last_built: 2023-08-15T15:37Z
 urls:
   reference: https://stapm.gitlab.io/r-packages/lfsclean/reference
   article: https://stapm.gitlab.io/r-packages/lfsclean/articles
diff --git a/vignettes/lfsclean.Rmd b/vignettes/lfsclean.Rmd
index 1c2b42c..5f45dac 100644
--- a/vignettes/lfsclean.Rmd
+++ b/vignettes/lfsclean.Rmd
@@ -9,15 +9,21 @@ vignette: >
 
 The **inputs** are the raw LFS data files obtained from the [UK Data Service](https://ukdataservice.ac.uk/). __These must be the tab delimited versions of the data, not Stata or SPSS__, and all individual tab delimited files needed must be placed together in a single directory. 
 
-A typical workflow for using the package looks as follows, with the read data function for each individual year contained within a global cleaning function which applies each cleaning function in turn. The collection of global cleaning functions for each year are then wrapped in a function to combine years of data.
+A typical workflow for using the package looks as follows, with the read data function for each individual year contained within a global cleaning function which applies each cleaning function in turn. The collection of global cleaning functions for each year are then wrapped in a function to combine years of data into a single data table for output.
+
+### Quarterly cross-sectional datasets
 
 The `lfsclean()` wrapper function is used to process multiple quarterly cross-sectional LFS data files into a single dataset of cleaned variables.
 
 ```{r workflow, message = FALSE, eval = FALSE}
 
-#### read in and clean raw data using the package
+## Load the package and other useful libraries
+
+library(lfsclean)
+library(tidyverse)
+library(ggthemes)
+library(zoo)
 
-####################
 ## input arguments
 
 root  <- "C:/"
@@ -41,10 +47,19 @@ lfs_data <- lfsclean(root = root,
 
 ```
 
+### Longitudinal datasets
+
 The `lfsclean_5q()` wrapper function is used to process the raw five-quarter longitudinal data. The arguments are simular to those used for the quarterly data cleaning function. `year` in this case refers to the calendar year in which the first wave of the longitudinal data was interviewed e.g. setting year equal to 2020 would read in, clean, and combine the four longitudinal datasets which began in January-March, April-June, July-September, and October-December of 2020.
 
 ```{r workflow-long, message = FALSE, eval = FALSE}
 
+## Load the package and other useful libraries
+
+library(lfsclean)
+library(tidyverse)
+library(ggthemes)
+library(zoo)
+
 ## input arguments
 
 root  <- "U:/"