openintrostat/openintro

📦 R package for data and supplemental functions for OpenIntro resources

openintro

Supplemental functions and data for OpenIntro resources, which includes open-source textbooks and resources for introductory statistics at openintro.org. The package contains datasets 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. Note that many functions and examples include color transparency; some plotting elements may not show up properly (or at all) when run in some versions of Windows operating system.

Installation

You can install the released version of openintro from CRAN with:

install.packages("openintro")

You can install the development version of openintro from GitHub with:

# install.packages("devtools")
library(devtools)
install_github("OpenIntroStat/openintro")

This package was produced as part of the OpenIntro project. For the accompanying textbook, visit openintro.org. A PDF of the textbook is free and paperbacks can be purchased online (royalty-free).

Questions, bugs, feature requests

You can file an issue to get help, report a bug, or make a feature request.

When filing an issue to get help or report a bug, please make a minimal reproducible example using the reprex package. If you haven’t heard of or used reprex before, you’re in for a treat! Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it’ll take you to learn what it’s all about). For additional reprex pointers, check out the Get help! section of the tidyverse site.

Before opening a new issue, be sure to search issues and pull requests to make sure the bug hasn’t been reported and/or already fixed in the development version. By default, the search will be pre-populated with is:issue is:open. You can edit the qualifiers (e.g. is:pr, is:closed) as needed. For example, you’d simply remove is:open to search all issues in the repo, open or closed.

Contributing

Process for adding new data to the package

The following steps use the devtools and usethis packages for various steps. We recommend using this process when suggesting new datasets to be added to the package. If the dataset is large (>500MB) or you’d like to add a function, please open an issue first for discussion before making the pull request.

1. Fork and clone the repo with usethis::create_from_github("OpenIntroStat/openintro")
   • Note: If you have write access to the repo, you can skip this step.
2. Start a new pull request with usethis::pr_init("BRANCH-NAME"), where BRANCH-NAME is an informative branch name.
3. If adding a file that is not an .rda file to begin with (Excel, csv, etc.), create a folder in the data-raw folder with the name of the dataset (how you’d like it to show up in the package). Please use snake_case for naming, e.g. name_of_dataset.
4. Place your dataset in its raw form in the folder.
5. 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.
6. 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).
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::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 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.
10. In the pkgdown.yml file, add the name of the dataset under reference, in the correct alphabetical order.
11. 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”.

Code of Conduct

Please note that the openintro project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

openintro's Issues

[Feature]: Add aldrin data

Contact Details

No response

Source

The aldrin dataset from slides is not in the package.

Source is at https://github.com/OpenIntroStat/openintro-statistics-slides/tree/master/Chp%207/7-5_anova/figures/aldrin.

Desired Solution

No response

Alternative Solutions

No response

Additional context

No response

dotPlot() collides with mosaic::dotPlot()

From looking at your examples, I'm not exactly sure what the purpose of your dotPlot() is supposed to be, but it is unfortunate that you have chosen a name that conflicts with the version in the mosaic package, which makes the kind of dot plot often seen in introductory statistics courses.

mosaic::dotPlot( ~ rnorm(500), width = 0.1)

ami_occurrences - need better description

Are observations people, days, something else? Docs will need to be updated accordingly.

Incorrect title on docs: hfi

Says absenteeism, should say Human Freedom Index

Make sure to alias countyComplete with county_complete

nuff said

As per the Korean font error

Hi,

When I render the image with Korean Character, the Korean characters are broken.
-. myPDF in variable.R

However, for instance, when I test the CairoPDF, the Korean characters are rendered correctly, but there are width and height issues.

I think that the other asian characters will have similar issues when using openintro package.

Thank you.

ask documentation

it says "something is wrong" but nothing is wrong

rosling_responses mentioned in text but not present in package

On page 191 the Fourth Edition of the textbook mentions the rosling_responses data set:

"We will use the rosling_responses data set to evaluate the hypothesis test ..."

Use of the texttt font for "rosling_responses" suggests that such a data set exists in the package, but it doesn't.

Description sentence

Make dataset one word in DESCRIPTION

yrbss documentation

Do we know which year's survey is included in this dataset? Also, do we know if the variable called gender is what's identified in the 2017 data documentation as sex?

I'm happy to do a PR to clarify those things if we can track them down.

Push new package version to CRAN?

@mine-cetinkaya-rundel can we push a new version of openintro to CRAN? We're using the latest version from github in your datacamp courses, but I think there's been some confusion among students since it differs from what's on CRAN.

Why mask data sets in datasets?

This seems unnecessary and confusing:

library(openintro)
## Please visit openintro.org for free statistics materials
## 
## Attaching package: ‘openintro’
## 
## The following objects are masked from ‘package:datasets’:
## 
##     cars, chickwts, trees

code by chapter

Is there a place where I can find the R code by chapter for the openintro book ?

Adjust treeDiag() function to have an option to output counts

For example, rather than give probabilities, show how 1000 cases would cascade through the tree.

Email data corrections

• In both email and email50 there are variables in the docs that don't exist in the data: period_mess and signoff -- should be removed from docs
• email50 example code yields FALSE (random sampling change might be the cause?)
• In both datasets indicator variables should be factors
• cc is numeric, not indicator

Add a page with csv download for all data

This would be helpful for non-R users of the datasets.

@DavidDiez I know you host these on openintro.org but keeping synced seems a challenge. I could automate it here and post on the package websites and openintro.org could point to them. Or I suppose you could build the page on your end based on the automatically generated files in this repo as well. We should discuss which approach is preferable, but at least automatically generating files as we update the package seems like a good idea.

Pull out larger datasets into their own packages

...and make it a dependency of OpenIntro

Rewrite examples in mlbbat10

Current in \dontrun{} but they need to be checked and rewritten

Remove message that appears when package loads

Referring to the text that says "Please visit openintro.org for free statistics". It shows up in the compiled markdown documents (as shown below), and yes, it's possible to mute that with the message = FALSE option in the chunk, but I think we want to be careful about teaching those to students who are new to R.

Leaving the issue here to be consider before the next version of the package...

chapter 5 - anova - bat10 dataset not found

Hi,

Please I don't find bat10 dataset use in the ANOVA of chapter 5 Inference for numerical data

Where could I download it please ?

find source of murders dataset

it's not documented

[Bug]: fastfood data has incorrect salad variable

Contact Details

[email protected]

Bug

The fastfood data set has a salad variable with all 515 values "Other". Looking at the item descriptions, it does appear that there are actual salads in the data set.

Reproducible Example

library(openintro)
#> Loading required package: airports
#> Loading required package: cherryblossom
#> Loading required package: usdata
table(fastfood$salad)
#>
#> Other
#> 515

Expected Behavior

I expected to see some foods classified as salads and others, not.

Session Info

No response

Additional context

No response

yrbss isn't in the OpenIntro packages

Hi,
the yrbss data is used in the OpenIntro text.
The yrbss data is available to download on the Github site.
So far as I can tell, the yrbss data hasn't been added to the OpenIntro packages.
Should it be?

qqnormsim() ideas

1. Use scales == "free" or better, add a scales argument that defaults to "free". [Else a sample with an outlier will cause the other plots to look quite different from how they would look if they were generated in isolation.]

2. Don't hard code the number of simulations. Let 8 be the default if you like.

3. rename first argument? It's a bit of an odd name. But I'm guessing it will typically be used without naming, so this is not such a big deal.

4. Consider a version that doesn't label the original data but makes it one of the sample (randomly selecting which location). Not sure the best way to do the "reveal".

5. Perhaps add a seed argument that sets the seed used. That would solve the reveal issue in one way, since the plot could be generated again withe the original data set distinguished.

6. Complete the documentation and include examples.

Add additional citation to BAC

openintro/R/data-bac.R

Line 15 in 7b3c5f2

#' @source J. Malkevitch and L.M. Lesser. For All Practical Purposes:

From Jack Miller:

The blood alcohol data set has been around since 1992 and appeared in the Electronic Encyclopedia of Statistical Examples and Exercises. I worked on EESEE and used the data sets at OSU, so I am very familiar with that particular citation. :-) Here is a URL for that particular "story" in EESEE: http://bcs.whfreeman.com/WebPub/Statistics/shared_resources/EESEE/BloodAlcoholContent/index.html.

This change will need to propagate to IMS and other books that reference this dataset as well.

add R Markdown lab report template

R Markdown has the ability to create templates. Could we create a lab report template for the On Your Own questions that instructors could use in their classes?

add "babies" dataset referenced in EOCE 6.1 of ISRS

Unless I am missing it, this is neither the births nor the ncbirths data set.

Side note: Is it necessary to have both births and ncbirths?

Add Nick Paterno to the package author list before next CRAN release

Nick has added a handful of data sets.

ipo data format and examples need revisiting

Revisit the format of the data and the examples provided