diff --git a/.Rbuildignore b/.Rbuildignore index 12c8514..188bb7f 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,5 @@ ^docs$ ^pkgdown$ ^CODE_OF_CONDUCT\.md$ +^doc$ +^Meta$ diff --git a/.gitignore b/.gitignore index c893a1e..120a78b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,6 @@ .quarto .vscode/ docs +inst/doc +/doc/ +/Meta/ diff --git a/DESCRIPTION b/DESCRIPTION index e076acd..883df55 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -20,7 +20,10 @@ Imports: stringr, tidyr Suggests: + knitr, + rmarkdown, testthat (>= 3.0.0), tibble Config/testthat/edition: 3 URL: https://big-life-lab.github.io/clsatools/, https://github.com/Big-Life-Lab/clsatools +VignetteBuilder: knitr diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 0000000..097b241 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1,2 @@ +*.html +*.R diff --git a/vignettes/vignette.Rmd b/vignettes/vignette.Rmd new file mode 100644 index 0000000..80978c2 --- /dev/null +++ b/vignettes/vignette.Rmd @@ -0,0 +1,19 @@ +--- +title: "Tutorial" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{Tutorial} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>" +) +``` + +```{r setup} +library(clsatools) +```