Please read these points carefully and follow them while filing issues.
Please file an issue before creating PRs so that it can be discussed first before you invest time implementing it.
master branch.master will not be accepted.References: If you are not sure how to issue a PR, but would like to contribute, these links should help get you started:
This guide was modified from the contributing guide for the data.table repository
All the vignettes should follow the same format. All sections are specified with three pound signs (###). Every class should include the following header:
---
title: "HTLTC-R: Reading and writing files"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{HTLTC-R: Reading and writing files}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, collapse = TRUE)
library(htltcR)
```
### Using this document
* Code blocks and R code have a grey background (note, code nested in the text is not highlighted in the pdf version of this document but is a different font).
* \# indicates a comment, and anything after a comment will not be evaluated in R
* The comments beginning with \#\# under the code in the grey code boxes are the output from the code directly above; any comments added by us will start with a single \#
* While you can copy and paste code into R, you will learn faster if you type out the commands yourself.
* Read through the document after class. This is meant to be a reference, and ideally, you should be able to understand every line of code. If there is something you do not understand please email us with questions or ask in the following class (you're probably not the only one with the same question!).
### Goals
1. ...The file should be placed in the vignettes folder with a simple name, ideally 1 word, and the “.Rmd” extension. The name after “HTLTC-R” can be longer and more descriptive. Please update it in both locations in the header. You can also add a final section called `### Exercises`` if you wish.
If you are using RStudio, running “Build & Reload” will not build the vignettes. You must run devtools::install(build_vignettes = TRUE) to test the installation.