From 7b3c5f2adfde5e678afef3dddd1de9a9d47dfd6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mine=20=C3=87etinkaya-Rundel?= Date: Tue, 20 Apr 2021 12:26:43 +0100 Subject: [PATCH] Fix typo, thanks @spcanelon --- README.Rmd | 3 +-- README.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index 65f9ff30..36263bd2 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,7 +18,6 @@ knitr::opts_chunk$set( [![R build status](https://github.com/OpenIntroStat/openintro/workflows/R-CMD-check/badge.svg)](https://github.com/OpenIntroStat/openintro/actions) - Supplemental functions and data for OpenIntro resources, which includes open-source textbooks and resources for introductory statistics at [openintro.org](https://www.openintro.org/). The package contains data sets used in our open-source textbooks along with custom plotting functions for reproducing book figures. 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 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. 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)`. 1. Restart R and run `devtools::load_all()` to make sure the data loads and run your examples to confirm they all work. -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. +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. 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. 1. In the `pkgdown.yml` file, add the name of the dataset under `reference`, in the correct alphabetical order. 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)". diff --git a/README.md b/README.md index 12fcd470..88522240 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ discussion before making the pull request. e.g. `library(dplyr)`, `library(ggplot2)`. 7. Restart R and run `devtools::load_all()` to make sure the data loads and run your examples to confirm they all work. -8. Run `devtools::docment()`, restart R, and then +8. Run `devtools::document()`, restart R, and then `devtools::load_all()`. Then, check out `?name_of_dataset` to make sure the documentation looks as expected. 9. Run `devtools::check()`. The only NOTE you should see as a result of