From 64cf999c2b22b9ed5b44fa4db71ab1c08f549222 Mon Sep 17 00:00:00 2001
From: Lpierott <l.pierotti@imperial.ac.uk>
Date: Fri, 29 Nov 2024 14:59:28 +0100
Subject: [PATCH] init

Use of the vignette
---
 .gitignore                 |  1 +
 DESCRIPTION                |  3 +++
 vignettes/.gitignore       |  2 ++
 vignettes/kaplan_meier.Rmd | 21 +++++++++++++++++++++
 4 files changed, 27 insertions(+)
 create mode 100644 vignettes/.gitignore
 create mode 100644 vignettes/kaplan_meier.Rmd

diff --git a/.gitignore b/.gitignore
index be71072..fc4cc5f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,3 +4,4 @@
 .Ruserdata
 
 *local*
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
index 20a1746..5f5313b 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -45,8 +45,10 @@ Suggests:
     callr,
     crosstable,
     gtools,
+    knitr,
     patchwork,
     plotly,
+    rmarkdown,
     rstudioapi,
     testthat (>= 3.0.0),
     usethis,
@@ -56,3 +58,4 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
 Config/testthat/edition: 3
 Config/testthat/parallel: true
+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/kaplan_meier.Rmd b/vignettes/kaplan_meier.Rmd
new file mode 100644
index 0000000..8d4321b
--- /dev/null
+++ b/vignettes/kaplan_meier.Rmd
@@ -0,0 +1,21 @@
+---
+title: "Kaplan Meier instruction suggestion"
+author: "LP"
+date: "2024-11-26"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{kaplan_meier}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(grstat)
+```