Article on how to insertStructure()

.Rbuildignore

@@ -11,4 +11,5 @@
 ^docs$
 ^pkgdown$
 ^README.html$
-^extras$
+^extras$
+^vignettes/articles$

DESCRIPTION

@@ -46,3 +46,4 @@ Suggests:
 Config/testthat/edition: 3
 URL: https://mi-erasmusmc.github.io/studyGenerics/
 VignetteBuilder: knitr
+Config/Needs/website: rmarkdown

_pkgdown.yml

@@ -1,4 +1,4 @@
-url: ~
+url: https://mi-erasmusmc.github.io/studyGenerics/
 template:
   bootstrap: 5
 

vignettes/articles/.gitignore

@@ -0,0 +1,2 @@
+/.quarto/
+**/*.quarto_ipynb

vignettes/articles/new_study_package.Rmd

@@ -0,0 +1,50 @@
+---
+title: "Inserting a New Package Structure"
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+## Create an empty project
+
+First, create a new empty project for your new study package with the package use this or from the menu in RStudio (Menu > File > New Project). The package will open a new instance of Positron or Rstudio. 
+
+```{r, eval=FALSE}
+library(usethis)
+
+usethis::create_package(
+  path = "~/P1C1001"
+  )
+
+```
+
+## Initiate an environment
+
+Inside the new study package use `renv` to initialise a new environment to start installing packages and install `studyGenerics`
+
+```{r, eval=FALSE}
+library(renv)
+
+renv::init()
+
+renv::install("mi-erasmusmc/studyGenerics")
+
+```
+
+## Insert the structure
+
+Finally, use the function `studyGenerics::insertStructure` to create a common configuration of packages and files to start developing a study package. You can use the parameter `n_obj` to define the number of objectives in your study. This will create a file to write a script for each objective in the /R folder. 
+
+```{r, eval=FALSE}
+library(studyGenerics)
+
+studyGenerics::insertStructure(
+  path = ".", # Default to create the study structure in the package you are currently in
+  n_obj = 3 # Default 3, in number.
+)
+
+```