In frank113/cmu202: Necessary Packages and Data for 36-202 at Carnegie Mellon University

library(cmu202)

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.align = "center",
  warning = FALSE,
  message = FALSE,
  echo = FALSE,
  fig.width = 7,
  height = 6
)

When working in an R Markdown file, R code is inserted in pieces of text known as code blocks. Within a code block, R commands may be used and are executed by default. The contents of a code chunk do not affect the text outside of the chunk and are useful for organizing processes. The result of the Each code block may use any variables and libraries called in a previous code chunk.

A code chunk is denoted by the following text:

cat(htmltools::includeText("code_chunk_example.txt"))

In this chunk we have the variable x being assigned to the number 1356.

Options are available for code chunk. Setting echo=TRUE ensures that readers will see the code as it is executed. Setting eval=TRUE ensures that the code within the code chunk will be evaluated regardless of ECHO. These options may be changed by adding them after the r in the opening tag:

See the following example:

cat(htmltools::includeText("code_chunk_echo.txt"))

echo and eval operate independently from one another -- for example echo=TRUE and eval=FALSE will display the raw code but not execute the code.

One may also insert a code chunk by clicking the green "insert" button to see a drop-down menu, after which click the "R" button (surrounded by the red box) as seen in the images below:

After clicking the buttons, you will have a code chunk!

Thank you to the user at this link for assisting in how to display a raw code block in the creation of the vignette.

frank113/cmu202 documentation built on July 17, 2020, 9:31 p.m.