Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown Lesson #11

Open
snystrom opened this issue Jun 12, 2018 · 6 comments
Open

Markdown Lesson #11

snystrom opened this issue Jun 12, 2018 · 6 comments
Assignees

Comments

@snystrom
Copy link
Member

Opening this to comply with contribution guidelines. Gonna introduce markdown. Yep.

@daynefiler
Copy link
Member

Use this at your 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. ...

And replace the name "Reading and writing files" with whatever you'd like. Call the file markdown.Rmd and put it in the vignettes folder.

The headers all use ### so they're not too big.

Feel free to add ### Exercises at the end.

@daynefiler
Copy link
Member

@aeallen We should add something along the lines of these instructions to either CONTRIBUTING or the README.

@aeallen
Copy link

aeallen commented Jun 12, 2018

I think that should be included in the CONTRIBUTING.

@daynefiler
Copy link
Member

@snystrom Were you planning on using this day 1? Is it finished?

@snystrom
Copy link
Member Author

Not finished. But I'm also not planning on using it... Don't think I've got the time to pull it together today, but if you want to give students something in the mean time try: Here and Here. Honestly, these are better resources than anything I'm going to pull together tonight.

The only thing students need to know for class (if you use .Rmd) anyway is

```{r}
code here
```

@daynefiler
Copy link
Member

Sounds good. I know what you mean -- putting this all together feels like a waste of time when I think about all the resources already available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants