Skip to content

Commit

Permalink
Reformat README + add CoC
Browse files Browse the repository at this point in the history
  • Loading branch information
mine-cetinkaya-rundel committed Dec 24, 2021
1 parent 9c672e6 commit 424ac6c
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 24 deletions.
24 changes: 24 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0,
available at [here](http://contributor-covenant.org/version/1/0/0/).
42 changes: 19 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
OpenIntro Labs - tidyverse
==============
OpenIntro Labs promote the understanding and application of statistics through applied data analysis.
Labs are titled based on topic area, which correspond to particular chapters in all three versions of OpenIntro Statistics, a free and open-source textbook.
The textbook as well as the html version of the labs can be found at [http://www.openintro.org/stat/labs.php](http://www.openintro.org/stat/labs.php).

OpenIntro Labs promote the understanding and application of statistics through
applied data analysis. Labs are titled based on topic area, which correspond to
particular chapters in all three versions of OpenIntro Statistics, a free and
open-source textbook. The textbook as well as the html version of the labs can
be found at [http://www.openintro.org/stat/labs.php](http://www.openintro.org/stat/labs.php).

This repository is a fork of the original base-R labs. It incorporates
the tidyverse syntax from the `dplyr` package for data manipulation, the `ggplot2`
package for graphics, and the `infer` package for statistical inference.

We currently support our source files in the RMarkdown (.Rmd) format, which can be output into
html format (though output to pdf is also possible). The source files are processed
using the [knitr](http://yihui.name/knitr/) package in R, and are easiest to use in [RStudio](https://www.rstudio.com/products/rstudio/download/).

It is our hope that these materials are useful for instructors and students of
statistics. If you end up developing some interesting variants of these labs or
creating new ones, please let us know!
This repository is a fork of the original base-R labs.
It incorporates the tidyverse syntax from the `dplyr` package for data manipulation, the `ggplot2` package for graphics, and the `infer` package for statistical inference.

## Labs

Expand All @@ -33,13 +19,23 @@ creating new ones, please let us know!
8. [Simple linear regression](http://openintrostat.github.io/oilabs-tidy/08_simple_regression/simple_regression.html)
9. [Multiple linear regression](http://openintrostat.github.io/oilabs-tidy/09_multiple_regression/multiple_regression.html)

## Source code for labs

We currently support our source files in the RMarkdown (.Rmd) format, which can be output into html format (though output to pdf is also possible).
The source files are processed using the [knitr](http://yihui.name/knitr/) package in R, and are easiest to use in [RStudio](https://www.rstudio.com/products/rstudio/download/).

## Feedback / collaboration

Your feedback is most welcomed! If you have suggestions for minor updates (fixing
typos, etc.) please do not hesitate to issue a pull request. If you have ideas for
major revamp of a lab (replacing outdated code with modern version, overhaul in
pedagogy, etc.) please create an issue so to start the conversation.
Your feedback is most welcomed! If you have suggestions for minor updates (fixing typos, etc.) please do not hesitate to issue a pull request.
If you have ideas for major revamp of a lab (replacing outdated code with modern version, overhaul in pedagogy, etc.) please create an issue so to start the conversation.

It is our hope that these materials are useful for instructors and students of statistics.
If you end up developing some interesting variants of these labs or creating new ones, please let us know!

## Code of Conduct

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

* * *

Expand Down
4 changes: 3 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
theme: jekyll-theme-minimal
theme: jekyll-theme-minimal
logo: logo/logo-square.png
title: OpenIntro Labs for R and tidyverse
Binary file added logo/logo-social.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logo/logo-square.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 424ac6c

Please sign in to comment.