Skip to content

Commit f786034

Browse files
Merge pull request #148 from arni-magnusson/main
Minor corrections in vignettes
2 parents 185d943 + c3a5fb2 commit f786034

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

vignettes/create_article.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The `create_article()` function will create the following files and folders:
3838

3939
The `.tex`, and `.sty` files make sure all the *R Journal* articles follow the same latex and reference style and should not be modified unless there is a strong reason to do so.
4040

41-
The `name` argument changes the name of the main R Markdown document, for example, if you wish to use `quokka-bilby` as the file name instead of `article`, create the article with:
41+
The `name` argument changes the name of the main R Markdown document, for example, if you wish to use `quokka-bilby` as the file name instead of `test`, create the article with:
4242

4343
```{r eval = FALSE}
4444
create_article(name = "quokka-bilby")
@@ -48,7 +48,7 @@ Please ensure that you stick to this folder structure when working with an R Jou
4848

4949
## Your first knit
5050

51-
To knit the `Rmd` file, you can use either through the RStudio `knit` button, or type the following command in the R console:
51+
To knit the `Rmd` file, you can use either the RStudio `knit` button, or type the following command in the R console:
5252

5353
```{r eval = FALSE}
5454
rmarkdown::render("quokka-bilby.Rmd")

vignettes/format-details.Rmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ This has these components:
3232
```
3333
output:
3434
rjtools::rjournal_article
35+
bibliography: RJreferences.bib
3536
```
36-
- `bibliography: RJreferences.bib`
3737

3838
# Figures
3939

@@ -48,7 +48,7 @@ Of course, if only a static plot is to be rendered in both outputs, a single cod
4848
For a static graph, use `\@ref(fig:penguins)` for in-text reference and your code chunk should look something like this:
4949

5050
````markdown
51-
`r ''````{r penguins, fig.cap="This is the figure caption"}
51+
`r ''````{r penguins, fig.cap="This is the figure caption."}
5252
penguins %>%
5353
ggplot(aes(x = flipper_length_mm,
5454
y = body_mass_g,
@@ -84,7 +84,7 @@ plotly::ggplotly(p1)
8484

8585
Notice here you need `eval=knitr::is_html_output()` and `eval=knitr::is_latex_output()` to make sure that the pdf output only evaluates the first chunk and the html output only evaluates the second.
8686

87-
For in-text citation, you will something like this:
87+
For in-text citation, you will need something like this:
8888

8989
Figure \@ref(fig:`r "\u0060r"` ifelse(knitr::is_html_output(), 'penguins-interactive', 'penguins-static')`r "\u0060"` shows ...
9090

@@ -113,7 +113,7 @@ Notice that `fig.width` and `fig.height` still apply here and `layout` option wi
113113
- `plotly::ggplotly(p, width = ..., height = ...)`, and
114114
- `ggiraph::girafe(p, width_svg = ..., height_svg = ...)`.
115115

116-
Sizing these figures should via the relevant arguments rather than the chunk options.
116+
Sizing these figures should be done via the relevant arguments rather than the chunk options.
117117

118118
## Captions with special formatting
119119

@@ -188,7 +188,7 @@ Both equations will be numbered, and referenced with `\@ref(eq:parityLoss2)`. S
188188

189189
# Citations
190190

191-
The citation style will be added during the building process and you can find the csl file [here](https://github.com/rjournal/rjtools/blob/main/inst/rjournal.csl). This style adopts a "capitalize-first" text case on title, which means it will capitalise the first world, including the one after the colon, and use lowercase for the rest. If you would like to preserve the text case of the title in the reference, wrap the word with curly braces. A common example of this is to preserve the lowercase R package name:
191+
The citation style will be added during the building process and you can find the csl file [here](https://github.com/rjournal/rjtools/blob/main/inst/rjournal.csl). This style adopts a "capitalize-first" text case on title, which means it will capitalise the first word, including the one after the colon, and use lowercase for the rest. If you would like to preserve the text case of the title in the reference, wrap the word with curly braces. A common example of this is to preserve the lowercase R package name:
192192

193193
```
194194
@Manual{crosstalk,

0 commit comments

Comments
 (0)