From 4f0b5b7e6ca5d71a10b0fbb70338e9fea5748741 Mon Sep 17 00:00:00 2001 From: Etienne Bacher <52219252+etiennebacher@users.noreply.github.com> Date: Sat, 24 Aug 2024 16:31:48 +0200 Subject: [PATCH] Put vignettes in `.Rbuildignore` (#534) * Put vignettes in `.Rbuildignore` * fix pkgdown --- .Rbuildignore | 2 ++ pkgdown/_pkgdown.yaml | 5 ++++ vignettes/overview_of_vignettes.Rmd | 40 +++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 vignettes/overview_of_vignettes.Rmd diff --git a/.Rbuildignore b/.Rbuildignore index d245bf8c3..65a0a7f67 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -48,3 +48,5 @@ references.bib ^CRAN-SUBMISSION$ docs ^.dev$ +^vignettes/s. +^vignettes/t. diff --git a/pkgdown/_pkgdown.yaml b/pkgdown/_pkgdown.yaml index d52994e16..6e6feb5b2 100644 --- a/pkgdown/_pkgdown.yaml +++ b/pkgdown/_pkgdown.yaml @@ -125,6 +125,11 @@ reference: - nhanes_sample articles: + - title: Overview of vignettes + navbar: ~ + contents: + - overview_of_vignettes + - title: Data Preparation desc: | Articles explaining utility of 'datawizard' for data wrangling diff --git a/vignettes/overview_of_vignettes.Rmd b/vignettes/overview_of_vignettes.Rmd new file mode 100644 index 000000000..9a6afc976 --- /dev/null +++ b/vignettes/overview_of_vignettes.Rmd @@ -0,0 +1,40 @@ +--- +title: "Overview of Vignettes" +output: + rmarkdown::html_vignette: +vignette: > + %\VignetteIndexEntry{Overview of Vignettes} + \usepackage[utf8]{inputenc} + %\VignetteEngine{knitr::rmarkdown} +editor_options: + chunk_output_type: console +--- + +```{r message=FALSE, warning=FALSE, include=FALSE} +library(knitr) +knitr::opts_chunk$set( + echo = TRUE, + collapse = TRUE, + warning = FALSE, + message = FALSE, + comment = "#>", + eval = TRUE +) +``` + +All package vignettes are available at [https://easystats.github.io/datawizard/](https://easystats.github.io/datawizard/). + +## Function Overview + +* [Function Reference](https://easystats.github.io/datawizard/reference/index.html) + + +## Data Preparation + +* [Coming from 'tidyverse'](https://easystats.github.io/datawizard/articles/tidyverse_translation.html) +* [A quick summary of selection syntax in `{datawizard}`](https://easystats.github.io/datawizard/articles/selection_syntax.html) + + +## Statistical Transformations + +* [Data Standardization](https://easystats.github.io/datawizard/articles/standardize_data.html)