Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/openintrostat/openintro

📦 R package for data and supplemental functions for OpenIntro resources

https://github.com/openintrostat/openintro

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 15 committers (13.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (20.3%) to scientific vocabulary

Keywords

data openintro rstats rstats-package

Keywords from Contributors

tidy-data tidyverse
Last synced: 10 months ago · JSON representation

Repository

📦 R package for data and supplemental functions for OpenIntro resources

Basic Info
Statistics
  • Stars: 240
  • Watchers: 36
  • Forks: 180
  • Open Issues: 5
  • Releases: 3
Topics
data openintro rstats rstats-package
Created almost 12 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Code of conduct

README.Rmd 

---
output: github_document
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "80%"
)
```

# openintro Hex logo for package


[![CRAN status](https://www.r-pkg.org/badges/version/openintro)](https://cran.r-project.org/package=openintro)
[![R-CMD-check](https://github.com/OpenIntroStat/openintro/workflows/R-CMD-check/badge.svg)](https://github.com/OpenIntroStat/openintro/actions)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/openintro)](https://cran.r-project.org/package=openintro)


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 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](https://CRAN.R-project.org) with:

``` r
install.packages("openintro")
```

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

``` r
# 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](https://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 **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) 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!](https://www.tidyverse.org/help/) section of the tidyverse site.

Before opening a new issue, be sure to [search issues and pull requests](https://github.com/openintrostat/openintro/issues) 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](https://help.github.com/articles/searching-issues-and-pull-requests/) (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.
1. Start a new pull request with `usethis::pr_init("BRANCH-NAME")`, where `BRANCH-NAME` is an informative branch name.
1. 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`.
1. Place your dataset in its raw form in the folder.
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::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)".


## Code of Conduct
  
Please note that the openintro project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). 
By contributing to this project, you agree to abide by its terms.

Owner

  • Name: OpenIntro
  • Login: OpenIntroStat
  • Kind: organization
  • Email: admin@openintro.org

The mission of OpenIntro is to make educational products that are free, transparent, and lower barriers to education.

GitHub Events

Total
  • Watch event: 17
  • Delete event: 3
  • Push event: 4
  • Pull request event: 4
  • Fork event: 2
  • Create event: 2
Last Year
  • Watch event: 17
  • Delete event: 3
  • Push event: 4
  • Pull request event: 4
  • Fork event: 2
  • Create event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 418
  • Total Committers: 15
  • Avg Commits per committer: 27.867
  • Development Distribution Score (DDS): 0.567
Past Year
  • Commits: 11
  • Committers: 4
  • Avg Commits per committer: 2.75
  • Development Distribution Score (DDS): 0.455
Top Committers
Name Email Commits
Mine Çetinkaya-Rundel c****e@g****m 181
David Diez d****d@o****g 91
Mine Cetinkaya-Rundel m****e@s****u 73
OpenIntroOrg o****g@g****m 37
Nick Paterno 4****o 15
Albert Y. Kim a****m@g****m 5
David Diez d****z@g****m 5
npaterno n****o@g****m 2
Jo Hardin h****7 2
OpenIntro O****g 2
ngoguened n****i@s****k 1
Suriyaa Sundararuban g****b@s****k 1
Ben Baumer b****r@g****m 1
Joyce Robbins j****3 1
Amelia McNamara a****a@g****m 1
Committer Domains (Top 20 + Academic)
suriyaa.tk: 1 sms.ed.ac.uk: 1 stat.duke.edu: 1 openintro.org: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 30
  • Total pull requests: 49
  • Average time to close issues: over 1 year
  • Average time to close pull requests: about 1 month
  • Total issue authors: 13
  • Total pull request authors: 12
  • Average comments per issue: 1.83
  • Average comments per pull request: 1.14
  • Merged pull requests: 44
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mine-cetinkaya-rundel (14)
  • rpruim (3)
  • beanumber (2)
  • DavidDiez (2)
  • dragonshill (1)
  • homerhanumat (1)
  • ajkl (1)
  • hardin47 (1)
  • statkclee (1)
  • andrewpbray (1)
  • maelfosso (1)
  • ncarchedi (1)
  • VectorPosse (1)
Pull Request Authors
  • mine-cetinkaya-rundel (21)
  • npaterno (13)
  • hardin47 (4)
  • rudeboybert (4)
  • DavidDiez (4)
  • sjvrensburg (2)
  • suriyaa (1)
  • AmeliaMN (1)
  • ngoguened (1)
  • jtr13 (1)
  • mnunes (1)
  • beanumber (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 6,517 last-month
  • Total docker downloads: 42,058
  • Total dependent packages: 2
  • Total dependent repositories: 33
  • Total versions: 12
  • Total maintainers: 1
cran.r-project.org: openintro

Datasets and Supplemental Functions from 'OpenIntro' Textbooks and Labs

  • Versions: 12
  • Dependent Packages: 2
  • Dependent Repositories: 33
  • Downloads: 6,517 Last month
  • Docker Downloads: 42,058
Rankings
Forks count: 0.3%
Stargazers count: 1.9%
Downloads: 4.6%
Dependent repos count: 4.6%
Average: 8.5%
Dependent packages count: 13.7%
Docker downloads count: 25.8%
Maintainers (1)
cetinkaya.mine@gmail.com
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • airports * depends
  • cherryblossom * depends
  • usdata * depends
  • ggplot2 >= 2.2.1 imports
  • graphics * imports
  • readr * imports
  • rmarkdown * imports
  • tibble * imports
  • broom * suggests
  • dplyr * suggests
  • forcats * suggests
  • knitr * suggests
  • lubridate * suggests
  • scales * suggests
  • testthat >= 3.0.0 suggests
  • tidyr * suggests
  • tidytext * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/pkgdown.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite