vignettes/contributing_tutorials.Rmd
contributing_tutorials.RmdTo add a new example to the website https://drieslab.github.io/Giotto_website/, please follow these steps:
Clone the Giotto_website repository from https://github.com/drieslab/Giotto_website and switch to the “suite” branch.
Create a new .Rmd (R markdown) file under the folder “vignettes”.
---
title: "TITLE TO USE"
output:
html_document:
number_sections: true
toc: true
pkgdown:
as_is: true
vignette: >
%\VignetteIndexEntry{TITLE TO USE}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---Absolutely no eval=TRUE for example code. To save time when rendering the website, all chunks should not evaluate the code.
Image results should be included via linking or a knitr chunk of this style:
#knitr::include_graphics("images/TUTORIAL_FOLDER/#_IMAGE_NAME.png")The upper case sections just show which areas should be edited, not that they need to be upper case
Add the text and code of your tutorial. Please use similar variable names to previous tutorials, we have created a list of common variables and default values in this spreadsheet.
Knit the document to check if the vignette looks how you like, and that it actually knits properly.
Optionally, you can run pkgdown::build_site(), but this may be hard to run locally.
pkgdown.yml is a file at the repo toplevel and it details how the links are set up for the navbars and documentation in the website.
For most new articles:
.html).