Merge pull request #878 from josschavezf/suite

add singularity tutorial

_pkgdown.yml

@@ -92,6 +92,8 @@ navbar:
         href: articles/terra.html
       - text: Docker
         href: articles/docker.html
+      - text: Singularity
+        href: articles/singularity.html
     articles:
       text: Examples
       menu:
@@ -210,6 +212,7 @@ articles:
   contents:
   - terra
   - docker
+  - singularity
 - title: Spatial Manipulation
   navbar: ~
   contents:

vignettes/singularity.Rmd

@@ -0,0 +1,24 @@
+---
+title: "Singularity container"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Singularity container}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+# Singularity container with bash terminal
+
+You can set up a Singularity container based on the [Giotto Docker Image]  (https://hub.docker.com/r/giottopackage/suite) able to run in a bash environment.
+
+## Instructions
+
+Follow these instructions to create your own Singularity and run
+Giotto:
+
+1.  singularity pull suite.sif docker://giottopackage/suite:latest
+2.  singularity shell suite.sif
+3.  R
+4.  Run the following **in R**:
+    1.  library(Giotto)
+5.  Now you can run any analysis with Giotto!