Skip to content

Commit 74ae6e8

Browse files
authored
Merge pull request #1 from rcurty/il-changes2
Il changes2
2 parents 2cb233e + 2c3030e commit 74ae6e8

6 files changed

Lines changed: 13 additions & 13 deletions

File tree

episodes/01-introduction.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ start: yes
1717
:::::::::::::::::::::::::::::::::::::::: questions
1818

1919
- What is reproducible research?
20-
- How can RStudio help research to be more reproducible?
20+
- How can RStudio help research be more reproducible?
2121
- What are the benefits of using RStudio for writing academic essays and papers?
2222

2323
::::::::::::::::::::::::::::::::::::::::::::::::::
@@ -93,16 +93,16 @@ Let's assume I have convinced you that reproducibility and transparency are in y
9393

9494
From day one and throughout the whole research life cycle! Before starting the project, you might have to learn tools like R or Git. If you wait too long while doing the analysis, you might lose a lot of time trying to remember what you did two months ago. When you write the paper, you want up-to-date numbers, tables, and figures. When you co-author a paper, you want to make sure that the analyses presented in a paper with your name on it are sound. When you review a paper, you can't judge the results if you don't know how the authors got there.
9595

96-
[Alexander (2023)](https://rohanalexander.github.io/telling_stories-published) argues that reproducibility often starts out as a burden—something others require of you, and it can feel tedious or frustrating. But that perception usually changes the moment you return to a project after some time away. Then, it becomes clear that reproducibility isn’t just essential for advancing data science—it’s also a practical tool that makes your own work easier to understand and build upon later. To achieve reproducibility the author suggests a three-step approach:
96+
[Alexander (2023)](https://rohanalexander.github.io/telling_stories-published) argues that reproducibility often starts out as a burden—something others require of you, and it can feel tedious or frustrating. But that perception usually changes the moment you return to a project after some time away. Then, it becomes clear that reproducibility isn’t just essential for advancing data science—it’s also a practical tool that makes your own work easier to understand and build upon later. To achieve reproducibility, the author suggests a three-step approach:
9797

9898
1) Ensure the entire workflow is documented. This may involve addressing questions such as:
9999

100100
- How was the raw dataset obtained, and is access likely to be persistent and available to others?
101-
- What specific steps are being taken to transform the raw data in the data that were analyzed, and how can this be made available to others?
101+
- What specific steps are being taken to transform the raw data into the data that was analyzed, and how can this be made available to others?
102102
- What analysis has been done, which codes/scripts were used, and how can this be shared clearly?
103103
- How has the final paper or report been built, and to what extent can others follow that process themselves?
104104

105-
2) Try to accomplish progressively the following requirements:
105+
2) Try to progressively accomplish the following requirements:
106106

107107
- Can you run your entire workflow again?
108108
- Can another person run your entire workflow again?
@@ -139,7 +139,7 @@ RStudio has a handy "Environment" window, which shows all of the objects you hav
139139

140140
### Makes it easy to set your working directory and access files on your computer
141141

142-
With RStudio, you can navigate to folders on your computer in the "Files" window, view any files you have in that folder, or go to your working directory. You can create projects that help you set your working directory and work with relative paths"to external" files (such as input data and figures) so it can also be used on other machines.
142+
With RStudio, you can navigate to folders on your computer in the "Files" window, view any files you have in that folder, or go to your working directory. You can create projects that help you set your working directory and work with relative paths to external files (such as input data and figures), so it can also be used on other machines.
143143

144144
### Integrates with collaboration and publishing tools
145145

@@ -162,7 +162,7 @@ Developers picked a name that had meaning in the history of publishing and lande
162162

163163
## Why Quarto and not R Markdown?
164164

165-
As noted before, Quarto is the next generation of R Markdown and the anatomy of `.rmd` and `.qmd` files are very similar. So why move to Quarto? While compatible with Python (and bash, Julia, C, SQL), R Markdown was designed primarily for R users. **Quarto does not require R.** Quarto runs computations into separate pluggable language "engine," which helps make this cross-language functionality easier to support and reduces infrastructure intensity with built-in applications. In addition, because Quarto is designed to be compatible with existing formats, you can render most existing `.Rmd` and Jupyter Notebooks with Quarto without modification. This low-pain process helps the transition to Quarto.
165+
As noted before, Quarto is the next generation of R Markdown, and the anatomy of `.rmd` and `.qmd` files is very similar. So why move to Quarto? While compatible with Python (and bash, Julia, C, SQL), R Markdown was designed primarily for R users. **Quarto does not require R.** It supports multiple languages by delegating code execution to external engines, such as Jupyter for Python and Julia, or knitr for R. This design helps support cross-language workflows and reduces infrastructure dependencies. In addition, because Quarto is designed to be compatible with existing formats, you can render most existing `.Rmd` and Jupyter Notebooks in Quarto without modification. This helps ease the transition to Quarto.
166166

167167

168168
::::::::::::::::::::::::::::::::::::::::::::::::::
@@ -175,7 +175,7 @@ Nitsch, F. J., Sellitto, M., \& Kalenscher, T. (2021). Trier social stress test
175175

176176
We will also be using a simplified version of the project directory containing data files and scripts published by the authors on Open Science Framework: <https://doi.org/10.17605/OSF.IO/6MVQ7>.
177177

178-
The adapted paper template and project directory are used exclusively for instruction purposes with permission from the authors.
178+
The adapted paper template and project directory are used exclusively for instructional purposes with permission from the authors.
179179

180180
:::::::::::::::::::::::::::::::::::::::: keypoints
181181

episodes/02-quarto/01-basic-rstudio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This lesson assumes you already have a basic understanding of R and RStudio but
3232
we will do a brief tour of the IDE, review R projects, and the best practices for
3333
organizing your work, and how to install or check packages you need to follow along.
3434

35-
Now, let's open RStudio. After passing authentication, choose `RStudio`. If you want to follow along using your local RStudio, make sure you use IDE version RStudio v2023.06 or later and that it is running [Quarto version 1.4 or above](https://quarto.org/docs/download/prerelease.html). If you need to check that, for RStudio, choose `Help` and `About RStudio`. For the Quarto version checking, type in `packageVersion("quarto")` on the console.
35+
Now, let's open RStudio. After passing authentication, choose `RStudio`. If you want to follow along using your local RStudio, make sure you use IDE version RStudio v2023.06 or later and that it is running [Quarto version 1.4 or above](https://quarto.org/docs/download/release.html). If you need to check that, for RStudio, choose `Help` and `About RStudio`. For the Quarto version checking, type in `packageVersion("quarto")` on the console.
3636

3737

3838
**Basic layout**

episodes/03-basic-rstudio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This lesson assumes you already have a basic understanding of R and RStudio but
3535
we will do a brief tour of the IDE, review R projects, and the best practices for
3636
organizing your work, and how to install or check packages you need to follow along.
3737

38-
Now, let's open RStudio. After passing authentication, choose `RStudio`. If you want to follow along using your local RStudio, make sure you use IDE version RStudio v2023.06 or later and that it is running [Quarto version 1.4 or above](https://quarto.org/docs/download/prerelease.html). If you need to check that, for RStudio, choose `Help` and `About RStudio`. For the Quarto version checking, type in `packageVersion("quarto")` on the console.
38+
Now, let's open RStudio. After passing authentication, choose `RStudio`. If you want to follow along using your local RStudio, make sure you use IDE version RStudio v2023.06 or later and that it is running [Quarto version 1.4 or above](https://quarto.org/docs/download/release.html). If you need to check that, for RStudio, choose `Help` and `About RStudio`. For the Quarto version checking, type in `packageVersion("quarto")` on the console.
3939

4040
**Basic layout**
4141

episodes/03-collaboration/04-publishing-your-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Quarto offers some journal formats and made them available within the quarto-jou
121121

122122
This list is expected to grow rapidly with new contributions submitted to the [Quarto Journal Templates Repository](https://github.com/quarto-journals). You may also create your own templates following [these guidelines](https://quarto.org/docs/journals/templates.html).
123123

124-
Journal templates require features of Quarto version 1.2, so we must ensure we have the right version. You can check your Quarto version in the Terminal with the command: `quarto --version`. We should be good with that for this workshop, but if you are using a lab computer later on, you may need to update Quarto. See: [pre-release versions of Quarto](https://quarto.org/docs/download/prerelease.html)
124+
Journal templates require features of Quarto version 1.2 or later, so we must ensure we have the right version. You can check your Quarto version in the Terminal with the command: `quarto --version`. We should be good with that for this workshop, but if you are using a lab computer later on, you may need to update Quarto. See: [release versions of Quarto](https://quarto.org/docs/download/release.html)
125125

126126
Quarto uses a template command that can be called in the terminal to create an article in any of these formats. Suppose you want to use the Elsevier template. In Rstudio, in the terminal (if not showing, select `Tools > Terminal > New`), type `quarto use template quarto-journals/elsevier`. Then, follow the steps below:
127127

episodes/10-biblio-crossref.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ exercises: 10
2525

2626
## Why Cite?
2727

28-
Correctly citing and attributing publications is key to academic writing. Older versions of RStudio require [Pandoc's citation syntax](https://pandoc.org/MANUAL.html#citation-syntax) to render bibliographies correctly. We won't be covering this approach extensively in this workshop since the new visual editor has made this process much more simple. You can refer to our [previous workshop on R Markdown](https://ucsbcarpentry.github.io/R-markdown/06-citations-bib/index.html) pre-visual editor for more information.
28+
Correctly citing and attributing publications is key to academic writing. Older versions of RStudio require [Pandoc's citation syntax](https://pandoc.org/MANUAL.html#citation-syntax) to render bibliographies correctly. We won't be covering this approach extensively in this workshop since the new visual editor has made this process much simpler. You can refer to our [previous workshop on R Markdown](https://ucsbcarpentry.github.io/R-markdown/06-citations-bib/index.html) pre-visual editor for more information.
2929

3030
The new visual editor has made citations and cross-referencing much easier, by offering different options for referencing various types of sources. Before getting into these different features, let's first learn how you can call the citation window dialog on Rstudio and how to navigate these different options.
3131

@@ -45,7 +45,7 @@ Have you noticed that the YAML header contains "bibliography: references.bib". A
4545

4646
A file with the BIB file extension is a BibTeX Bibliographical Database file. It's a specially formatted text file that lists references pertaining to a particular source of information. They're normally seen only with the .`bib` file extension but might instead use `.bibitex`. BibTeX files might hold references for things like research papers, articles, books, etc. The file often includes an author's name, year, title, page number, and other related content. Each item can be edited, in case there is any metadata incorrect or missing.
4747

48-
Most citation and reference management tools such as Refworks, Endnote, Mendeley and Zotero, as well as some search engines (e.g., Google Scholar), most scientific databases, and our UCSB library catalog allow us to export citations aa [.bib or BibteX files](https://en.wikipedia.org/wiki/BibTeX). These files are used to describe and process lists of references, mostly in conjunction with LaTeX documents. Each .bib file has a citation key or ID preceded by an `@`, which uniquely identifies each item. Citation keys can be customized, as we will learn in a bit, but be advised that your manuscript will render citations correctly only if you have the cited item corresponding to its exact key.
48+
Most citation and reference management tools such as Refworks, Endnote, Mendeley and Zotero, as well as some search engines (e.g., Google Scholar), most scientific databases, and our UCSB library catalog allow us to export citations as [.bib or BibteX files](https://en.wikipedia.org/wiki/BibTeX). These files are used to describe and process lists of references, mostly in conjunction with LaTeX documents. Each .bib file has a citation key or ID preceded by an `@`, which uniquely identifies each item. Citation keys can be customized, as we will learn in a bit, but be advised that your manuscript will render citations correctly only if you have the cited item corresponding to its exact key.
4949

5050
## Inserting Citations
5151

episodes/14-publishing-your-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Quarto offers some journal formats and made them available within the quarto-jou
119119

120120
This list is expected to grow rapidly with new contributions submitted to the [Quarto Journal Templates Repository](https://github.com/quarto-journals). You may also create your own templates following [these guidelines](https://quarto.org/docs/journals/templates.html).
121121

122-
Journal templates require features of Quarto version 1.2, so we must ensure we have the right version. You can check your Quarto version in the Terminal with the command: `quarto --version`. We should be good with that for this workshop, but if you are using a lab computer later on, you may need to update Quarto. See: [pre-release versions of Quarto](https://quarto.org/docs/download/prerelease.html)
122+
Journal templates require features of Quarto version 1.2, so we must ensure we have the right version. You can check your Quarto version in the Terminal with the command: `quarto --version`. We should be good with that for this workshop, but if you are using a lab computer later on, you may need to update Quarto. See: [release versions of Quarto](https://quarto.org/docs/download/release.html)
123123

124124
Quarto uses a template command that can be called in the terminal to create an article in any of these formats. Suppose you want to use the Elsevier template. In Rstudio, in the terminal (if not showing, select `Tools > Terminal > New`), type `quarto use template quarto-journals/elsevier`. Then, follow the steps below:
125125

0 commit comments

Comments
 (0)