diff --git a/01-intro.Rmd b/01-intro.Rmd index 886eb528..deec016a 100644 --- a/01-intro.Rmd +++ b/01-intro.Rmd @@ -5,17 +5,13 @@ ottrpal::set_knitr_image_path() # Introduction - -## Motivation - - ## Target Audience -The course is intended for ... +The course is intended for researchers who want to learn coding for the first time with a data science application, or have explored programming and want to focus on fundamentals. ## Curriculum -The course covers... +The course covers fundamentals of R, a high-level programming language, and use it to wrangle data for analysis and visualization. The programming skills you will learn are transferable to learn more about R independently and other high-level languages such as Python. At the end of the class, you will be reproducing analysis from a scientific publication! ```{r} diff --git a/02-chapter_of_course.Rmd b/02-chapter_of_course.Rmd deleted file mode 100644 index 68835cfd..00000000 --- a/02-chapter_of_course.Rmd +++ /dev/null @@ -1,260 +0,0 @@ - -# A new chapter - -If you haven't yet read the getting started Wiki pages; [start there](https://www.ottrproject.org/getting_started.html). - -To see the rendered version of this chapter and the rest of the template, see here: https://jhudatascience.org/OTTR_Template/. - -Every chapter needs to start out with this chunk of code: - - -```{r, include = FALSE} -ottrpal::set_knitr_image_path() -``` - -## Learning Objectives - -Every chapter also needs Learning objectives that will look like this: - -This chapter will cover: - -- {You can use https://tips.uark.edu/using-blooms-taxonomy/ to define some learning objectives here} -- {Another learning objective} - -## Libraries - -For this chapter, we'll need the following packages attached: - -*Remember to add [any additional packages you need to your course's own docker image](https://github.com/jhudsl/OTTR_Template/wiki/Using-Docker#starting-a-new-docker-image). - -```{r} -library(magrittr) -``` - -## Topic of Section - -You can write all your text in sections like this, using `##` to indicate a new header. you can use additional pound symbols to create lower levels of headers. - -See [here](https://www.rstudio.com/wp-content/uploads/2015/02/rmarkdown-cheatsheet.pdf) for additional general information about how you can format text within R Markdown files. In addition, see [here](https://pandoc.org/MANUAL.html#pandocs-markdown) for more in depth and advanced options. - -### Subtopic - -Here's a subheading (using three pound symbols) and some text in this subsection! - -## Code examples - -You can demonstrate code like this: - -```{r} -output_dir <- file.path("resources", "code_output") -if (!dir.exists(output_dir)) { - dir.create(output_dir) -} -``` - -And make plots too: - -```{r} -hist_plot <- hist(iris$Sepal.Length) -``` - -You can also save these plots to file: - -```{r} -png(file.path(output_dir, "test_plot.png")) -hist_plot -dev.off() -``` - -## Image example - -How to include a Google slide. It's simplest to use the `ottrpal` package: - - -```{r, fig.align='center', out.width="100%", echo = FALSE, fig.alt= "Major point!! example image"} -ottrpal::include_slide("https://docs.google.com/presentation/d/1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ/edit#slide=id.gcc4fbee202_0_141") -``` - -But if you have the slide or some other image locally downloaded you can also use HTML like this: - - - -## Video examples -You may also want to embed videos in your course. If alternatively, you just want to include a link you can do so like this: - -Check out this [link to a video](https://www.youtube.com/embed/VOCYL-FNbr0) using markdown syntax. - -### Using `knitr` - -To embed videos in your course, you can use `knitr::include_url()` like this: -Note that you should use `echo=FALSE` in the code chunk because we don't want the code part of this to show up. If you are unfamiliar with [how R Markdown code chunks work, read this](https://rmarkdown.rstudio.com/lesson-3.html). - - -```{r, echo=FALSE} -knitr::include_url("https://www.youtube.com/embed/VOCYL-FNbr0") -``` - -### Using HTML - - - -## File examples - -You can again use simple markdown syntax to just include a link to a file like so: - -[A file](https://www.bgsu.edu/content/dam/BGSU/center-for-faculty-excellence/docs/TLGuides/TLGuide-Learning-Objectives.pdf). - -Alternatively you can embed files like PDFs. - -### Using `knitr` - -```{r, fig.align="center", echo=FALSE, out.width="100%"} -knitr::include_url("https://drive.google.com/file/d/1mm72K4V7fqpgAfWkr6b7HTZrc3f-T6AV/preview") -``` - -### Using HTML - - - -## Website Examples - -Yet again you can use a link to a website like so: - -[A Website](https://yihui.org) - -You might want to have users open a website in a new tab by default, especially if they need to reference both the course and a resource at once. - -[A Website](https://yihui.org){target="_blank"} - -Or, you can embed some websites. - -### Using `knitr` - -This works: - -```{r, fig.align="center", echo=FALSE} -knitr::include_url("https://yihui.org") -``` - - -### Using HTML - - - - -If you'd like the URL to show up in a new tab you can do this: - -``` -LinkedIn -``` - -## Citation examples - -We can put citations at the end of a sentence like this [@rmarkdown2021]. -Or multiple citations [@rmarkdown2021, @Xie2018]. - -but they need a ; separator [@rmarkdown2021; @Xie2018]. - -In text, we can put citations like this @rmarkdown2021. - -## Stylized boxes - -Occasionally, you might find it useful to emphasize a particular piece of information. To help you do so, we have provided css code and images (no need for you to worry about that!) to create the following stylized boxes. - -You can use these boxes in your course with either of two options: using HTML code or Pandoc syntax. - -### Using `rmarkdown` container syntax - -The `rmarkdown` package allows for a different syntax to be converted to the HTML that you just saw and also allows for conversion to LaTeX. See the [Bookdown](https://bookdown.org/yihui/rmarkdown-cookbook/custom-blocks.html) documentation for more information [@Xie2020]. Note that Bookdown uses Pandoc. - - -``` -::: {.notice} -Note using rmarkdown syntax. - -::: -``` - -::: {.notice} -Note using rmarkdown syntax. - -::: - -As an example you might do something like this: - -::: {.notice} -Please click on the subsection headers in the left hand -navigation bar (e.g., 2.1, 4.3) a second time to expand the -table of contents and enable the `scroll_highlight` feature -([see more](introduction.html#scroll-highlight)) -::: - - -### Using HTML - -To add a warning box like the following use: - -``` -