Improved vignettes

ghar1821 · Aug 18, 2021 · f9446e0 · f9446e0
1 parent d620fda
commit f9446e0
Show file tree

Hide file tree

Showing 5 changed files with 528 additions and 325 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,5 @@
 .DS_Store
 .Rproj.user
 .Rhistory
-Meta/
-.Rproj
+/Meta/
+*.Rproj
diff --git a/doc/TrackSOM-workflow.R b/doc/TrackSOM-workflow.R
@@ -57,9 +57,14 @@ tracksom.result <- TrackSOM(inputFiles = data.files.fullpath,
 
 ## -----------------------------------------------------------------------------
 library(data.table)
-InputDirectory <- "~/Documents/GitHub/TrackSOM/inst/extdata/"
-data.files <- list.files(InputDirectory, ".csv")
-dat <- lapply(data.files, function(f) fread(paste0(InputDirectory, f)))
+data.files <- c(
+  system.file("extdata", "synthetic_d0.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d1.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d2.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d3.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d4.csv", package = "TrackSOM")
+)
+dat <- lapply(data.files, function(f) fread(f))
 dat <- rbindlist(dat)
 
 ## -----------------------------------------------------------------------------

diff --git a/doc/TrackSOM-workflow.Rmd b/doc/TrackSOM-workflow.Rmd
@@ -1,6 +1,12 @@
 ---
 title: "TrackSOM-workflow"
-output: rmarkdown::html_vignette
+output: 
+  rmarkdown::html_document:
+    toc: true
+    toc_float:
+      collapsed: false
+      smooth_scroll: false
+    keep_md: true
 author: Givanna Putri
 vignette: >
   %\VignetteIndexEntry{TrackSOM-workflow}
@@ -188,9 +194,14 @@ To facilitate the extraction of meta-clusters ID and SOM nodes for each cell, we
 To use `ConcatenateClusteringDetails`, you need to first read in all your datasets as one giant `data.table`.
 ```{r}
 library(data.table)
-InputDirectory <- "~/Documents/GitHub/TrackSOM/inst/extdata/"
-data.files <- list.files(InputDirectory, ".csv")
-dat <- lapply(data.files, function(f) fread(paste0(InputDirectory, f)))
+data.files <- c(
+  system.file("extdata", "synthetic_d0.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d1.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d2.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d3.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d4.csv", package = "TrackSOM")
+)
+dat <- lapply(data.files, function(f) fread(f))
 dat <- rbindlist(dat)
 ```
 

diff --git a/doc/TrackSOM-workflow.html b/doc/TrackSOM-workflow.html
diff --git a/vignettes/TrackSOM-workflow.Rmd b/vignettes/TrackSOM-workflow.Rmd
@@ -1,6 +1,12 @@
 ---
 title: "TrackSOM-workflow"
-output: rmarkdown::html_vignette
+output: 
+  rmarkdown::html_document:
+    toc: true
+    toc_float:
+      collapsed: false
+      smooth_scroll: false
+    keep_md: true
 author: Givanna Putri
 vignette: >
   %\VignetteIndexEntry{TrackSOM-workflow}
@@ -188,9 +194,14 @@ To facilitate the extraction of meta-clusters ID and SOM nodes for each cell, we
 To use `ConcatenateClusteringDetails`, you need to first read in all your datasets as one giant `data.table`.
 ```{r}
 library(data.table)
-InputDirectory <- "~/Documents/GitHub/TrackSOM/inst/extdata/"
-data.files <- list.files(InputDirectory, ".csv")
-dat <- lapply(data.files, function(f) fread(paste0(InputDirectory, f)))
+data.files <- c(
+  system.file("extdata", "synthetic_d0.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d1.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d2.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d3.csv", package = "TrackSOM"),
+  system.file("extdata", "synthetic_d4.csv", package = "TrackSOM")
+)
+dat <- lapply(data.files, function(f) fread(f))
 dat <- rbindlist(dat)
 ```