Skip to content

Commit 7b3c5f2

Browse files
Fix typo, thanks @spcanelon
1 parent c1517ee commit 7b3c5f2

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

README.Rmd

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ knitr::opts_chunk$set(
1818
[![R build status](https://github.com/OpenIntroStat/openintro/workflows/R-CMD-check/badge.svg)](https://github.com/OpenIntroStat/openintro/actions)
1919
<!-- badges: end -->
2020

21-
2221
Supplemental functions and data for OpenIntro resources, which includes open-source textbooks and resources for introductory statistics at [openintro.org](https://www.openintro.org/).
2322
The package contains data sets used in our open-source textbooks along with custom plotting functions for reproducing book figures.
2423
The package also contains the datasets used in OpenIntro labs.
@@ -73,7 +72,7 @@ If the dataset is large (>500MB) or you'd like to add a function, please open an
7372
1. Also in the `data-raw` folder, create a new R script called `name_of_dataset-dataprep.R` and write the code needed to read in the file, make any modifications to the data that are needed (if any), and end with `usethis::use_data()` to save the data in the package as an .rda file with the ideal compression. See examples from other folders in `data-raw` for sample code. The contents of this folder do not end up in the package (the entire folder is ignored in the `.Rbuildignore`) so you don't need to worry about adding package dependencies etc.
7473
1. In the `R` folder, create an R script called `data-name_of_dataset` and add documentation using Roxygen style. See other documentation files for help with style. In the examples, use tidyverse syntax but do not use `library(tidyverse)` and only use the relevant packages, e.g. `library(dplyr)`, `library(ggplot2)`.
7574
1. Restart R and run `devtools::load_all()` to make sure the data loads and run your examples to confirm they all work.
76-
1. Run `devtools::docment()`, restart R, and then `devtools::load_all()`. Then, check out `?name_of_dataset` to make sure the documentation looks as expected.
75+
1. Run `devtools::document()`, restart R, and then `devtools::load_all()`. Then, check out `?name_of_dataset` to make sure the documentation looks as expected.
7776
1. Run `devtools::check()`. The only NOTE you should see as a result of the check should be about the package size. If any other ERRORs, NOTEs, or WARNINGs are generated, resolve them or open an issue for help.
7877
1. In the `pkgdown.yml` file, add the name of the dataset under `reference`, in the correct alphabetical order.
7978
1. Add a note in the `NEWS.md` with the new dataset you've added with a link to your GitHub username so we can acknowledge your contribution, e.g. "added by [\@mine-cetinkaya-rundel](https://github.com/mine-cetinkaya-rundel)".

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ discussion before making the pull request.
101101
e.g. `library(dplyr)`, `library(ggplot2)`.
102102
7. Restart R and run `devtools::load_all()` to make sure the data loads
103103
and run your examples to confirm they all work.
104-
8. Run `devtools::docment()`, restart R, and then
104+
8. Run `devtools::document()`, restart R, and then
105105
`devtools::load_all()`. Then, check out `?name_of_dataset` to make
106106
sure the documentation looks as expected.
107107
9. Run `devtools::check()`. The only NOTE you should see as a result of

0 commit comments

Comments
 (0)