Skip to content

Commit

Permalink
Merge pull request #39 from jumpingrivers/cran-edits
Browse files Browse the repository at this point in the history
CRAN-edits
  • Loading branch information
osheen1 authored Sep 21, 2022
2 parents 29e97d7 + 081c915 commit ae07ddc
Show file tree
Hide file tree
Showing 20 changed files with 74 additions and 109 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@
^codemeta\.json$
^pkgdown$
^.lintr$
^CRAN-SUBMISSION$
^LICENSE\.md$
47 changes: 0 additions & 47 deletions .github/CONTRIBUTING.md

This file was deleted.

3 changes: 3 additions & 0 deletions CRAN-SUBMISSION
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Version: 0.1.6
Date: 2022-05-03 20:18:55 UTC
SHA: 29e97d78dfa8d28b6db13ef9477d2a8c954d92ed
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Description: The Datasaurus Dozen is a set of datasets with the same
Statistics through Simulated Annealing" <doi:10.1145/3025453.3025912>.
License: MIT + file LICENSE
URL: https://github.com/jumpingrivers/datasauRus,
https://jumpingrivers.github.io/datasauRus
https://jumpingrivers.github.io/datasauRus/
BugReports: https://github.com/jumpingrivers/datasauRus/issues
Depends:
R (>= 3.0.0)
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2017
COPYRIGHT HOLDER: Stephanie Locke
YEAR: 2022
COPYRIGHT HOLDER: datasauRus authors
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MIT License

Copyright (c) 2022 datasauRus authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 9 additions & 9 deletions R/datasaurus-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/box_plots.R
"box_plots"

Expand Down Expand Up @@ -57,7 +57,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/datasaurus_dozen_wide.R
"datasaurus_dozen_wide"

Expand All @@ -76,7 +76,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/datasaurus_dozen.R
"datasaurus_dozen"

Expand All @@ -98,7 +98,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats).#nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs).#nolint
#' @example inst/examples/simpsons_paradox_wide.R
"simpsons_paradox_wide"

Expand All @@ -119,7 +119,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/simpsons_paradox.R
"simpsons_paradox"

Expand All @@ -138,7 +138,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/twelve_from_slant_alternate_long.R
"twelve_from_slant_alternate_long"

Expand Down Expand Up @@ -178,7 +178,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/twelve_from_slant_alternate_wide.R
"twelve_from_slant_alternate_wide"

Expand All @@ -197,7 +197,7 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/twelve_from_slant_long.R
"twelve_from_slant_long"

Expand Down Expand Up @@ -237,6 +237,6 @@
#' Varied Appearance and Identical Statistics through Simulated
#' Annealing. _CHI 2017 Conference proceedings: ACM SIGCHI
#' Conference on Human Factors in Computing Systems._
#' Retrieved from [https://www.autodeskresearch.com/publications/samestats](https://www.autodeskresearch.com/publications/samestats). #nolint
#' Retrieved from [https://www.autodesk.com/research/publications/same-stats-different-graphs](https://www.autodesk.com/research/publications/same-stats-different-graphs). #nolint
#' @example inst/examples/twelve_from_slant_wide.R
"twelve_from_slant_wide"
21 changes: 8 additions & 13 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,24 @@ knitr::opts_chunk$set(
# datasauRus <img src="man/figures/logo.png" align="right" />

<!-- badges: start -->
[![CRAN version](http://www.r-pkg.org/badges/version/datasauRus)](https://cran.r-project.org/package=datasauRus) [![Downloads](http://cranlogs.r-pkg.org/badges/datasauRus)](http://cran.rstudio.com/web/packages/datasauRus/index.html)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN status](https://www.r-pkg.org/badges/version/datasauRus)](https://CRAN.R-project.org/package=datasauRus)
[![R-CMD-check](https://github.com/jumpingrivers/datasauRus/workflows/R-CMD-check/badge.svg)](https://github.com/jumpingrivers/datasauRus/actions)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
<!-- badges: end -->
<!-- badges: end -->

This package wraps the awesome Datasaurus Dozen datasets. The Datasaurus Dozen show us why visualisation is important -- summary statistics can be the same but distributions can be very different. In short, this package gives a fun alternative to [Anscombe's Quartet](https://en.wikipedia.org/wiki/Anscombe%27s_quartet), available in R as `anscombe`.

The original Datasaurus was created by Alberto Cairo in this great [blog post](http://www.thefunctionalart.com/2016/08/download-datasaurus-never-trust-summary.html).

The other Dozen were generated using simulated annealing and the process
The original Datasaurus was created by Alberto Cairo. The other Dozen were generated using simulated annealing and the process
is described in the paper "Same Stats, Different Graphs: Generating
Datasets with Varied Appearance and Identical Statistics through
Simulated Annealing" by Justin
Matejka and George Fitzmaurice ([open access materials including manuscript and code](https://www.autodeskresearch.com/publications/samestats), [official paper](https://doi.org/10.1145/3025453.3025912)).
Matejka and George Fitzmaurice ([open access materials including manuscript and code](https://www.autodesk.com/research/publications/same-stats-different-graphs), [official paper](https://doi.org/10.1145/3025453.3025912)).

In the paper, Justin and George simulate a variety of datasets that the same summary statistics to the Datasaurus but have very different distributions.


```{r, out.width="600px", fig.alt="Sequential dinosaur gif", echo = FALSE}
knitr::include_graphics("man/figures/DinoSequential.gif")
knitr::include_graphics("https://damassets.autodesk.net/content/dam/autodesk/research/publications-assets/gifs/same-stats-different-graphs/DinoSequentialSmaller.gif")
```

## Install
Expand Down Expand Up @@ -64,10 +62,7 @@ ggplot(datasaurus_dozen, aes(x = x, y = y, colour = dataset))+
facet_wrap(~dataset, ncol = 3)
```

## Contributing to the package

Want to report a bug or suggest a feature? Great stuff! For more information on how to contribute check out [our contributing guide](.github/CONTRIBUTING.md).

## Code of Conduct
## Code of Conduct

Please note that the datasauRus project is released with a [Contributor Code of Conduct](https://jumpingrivers.github.io/datasauRus/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms
Please note that the datasauRus project is released with a [Contributor Code of Conduct](https://jumpingrivers.github.io/datasauRus/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@

<!-- badges: start -->

[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN
version](http://www.r-pkg.org/badges/version/datasauRus)](https://cran.r-project.org/package=datasauRus)
[![Downloads](http://cranlogs.r-pkg.org/badges/datasauRus)](http://cran.rstudio.com/web/packages/datasauRus/index.html)
status](https://www.r-pkg.org/badges/version/datasauRus)](https://CRAN.R-project.org/package=datasauRus)
[![R-CMD-check](https://github.com/jumpingrivers/datasauRus/workflows/R-CMD-check/badge.svg)](https://github.com/jumpingrivers/datasauRus/actions)
[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
<!-- badges: end -->

This package wraps the awesome Datasaurus Dozen datasets. The Datasaurus
Expand All @@ -21,22 +19,20 @@ gives a fun alternative to [Anscombe’s
Quartet](https://en.wikipedia.org/wiki/Anscombe%27s_quartet), available
in R as `anscombe`.

The original Datasaurus was created by Alberto Cairo in this great [blog
post](http://www.thefunctionalart.com/2016/08/download-datasaurus-never-trust-summary.html).

The other Dozen were generated using simulated annealing and the process
is described in the paper “Same Stats, Different Graphs: Generating
Datasets with Varied Appearance and Identical Statistics through
Simulated Annealing” by Justin Matejka and George Fitzmaurice ([open
access materials including manuscript and
code](https://www.autodeskresearch.com/publications/samestats),
The original Datasaurus was created by Alberto Cairo. The other Dozen
were generated using simulated annealing and the process is described in
the paper “Same Stats, Different Graphs: Generating Datasets with Varied
Appearance and Identical Statistics through Simulated Annealing” by
Justin Matejka and George Fitzmaurice ([open access materials including
manuscript and
code](https://www.autodesk.com/research/publications/same-stats-different-graphs),
[official paper](https://doi.org/10.1145/3025453.3025912)).

In the paper, Justin and George simulate a variety of datasets that the
same summary statistics to the Datasaurus but have very different
distributions.

<img src="man/figures/DinoSequential.gif" title="Sequential dinosaur gif" alt="Sequential dinosaur gif" width="600px" />
<img src="https://damassets.autodesk.net/content/dam/autodesk/research/publications-assets/gifs/same-stats-different-graphs/DinoSequentialSmaller.gif" title="Sequential dinosaur gif" alt="Sequential dinosaur gif" width="600px" />

## Install

Expand Down Expand Up @@ -69,12 +65,9 @@ ggplot(datasaurus_dozen, aes(x = x, y = y, colour = dataset))+

![](man/figures/datasets-1.png)<!-- -->

## Contributing to the package

Want to report a bug or suggest a feature? Great stuff! For more
information on how to contribute check out [our contributing
guide](.github/CONTRIBUTING.md).
## Code of Conduct

Please note that this R package is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By participating in this package project
you agree to abide by its terms.
Please note that the datasauRus project is released with a [Contributor
Code of
Conduct](https://jumpingrivers.github.io/datasauRus/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms
2 changes: 1 addition & 1 deletion man/box_plots.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/datasaurus_dozen.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/datasaurus_dozen_wide.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file removed man/figures/DinoSequential.gif
Binary file not shown.
2 changes: 1 addition & 1 deletion man/simpsons_paradox.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/simpsons_paradox_wide.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/twelve_from_slant_alternate_long.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit ae07ddc

Please sign in to comment.