Skip to content

Commit ab61824

Browse files
committed
CRAN resubmission
1 parent e3fc313 commit ab61824

9 files changed

+36
-41
lines changed

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: fivethirtyeight
22
Title: Data and Code Behind the Stories and Interactives at FiveThirtyEight
3-
Description: Data and code behind the stories and interactives at FiveThirtyEight
4-
\url{https://github.com/fivethirtyeight/data}.
3+
Description: Data and code behind the stories and interactives at 'FiveThirtyEight'
4+
<https://github.com/fivethirtyeight/data>.
55
Version: 0.1.0
66
Authors@R: c(
77
person("Albert Y.", "Kim", email = "[email protected]", role = "cre"),

LICENSE

+1-19
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,2 @@
11
YEAR: 2014
2-
COPYRIGHT HOLDER: ESPN Internet Ventures
3-
4-
Permission is hereby granted, free of charge, to any person obtaining a copy
5-
of this software and associated documentation files (the "Software"), to deal
6-
in the Software without restriction, including without limitation the rights
7-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8-
copies of the Software, and to permit persons to whom the Software is
9-
furnished to do so, subject to the following conditions:
10-
11-
The above copyright notice and this permission notice shall be included in
12-
all copies or substantial portions of the Software.
13-
14-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20-
THE SOFTWARE.
2+
COPYRIGHT HOLDER: ESPN Internet Ventures

R/data_chester.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@
329329
#' \item{division}{NFL division}
330330
#' \item{avg_tix_price}{Average ticket price}
331331
#' }
332-
#' @source StubHub \url{http://www.stubhub.com/}
332+
#' @source StubHub stubhub.com
333333
"nfltix_div_avgprice"
334334

335335

@@ -345,7 +345,7 @@
345345
#' \item{team}{Name of NFL team}
346346
#' \item{avg_tix_price}{Average ticket price}
347347
#' }
348-
#' @source StubHub \url{http://www.stubhub.com/}
348+
#' @source StubHub stubhub.com
349349
"nfltix_usa_avg"
350350

351351

cran-comments.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
## Summary
22

3+
## Resubmission
4+
5+
This is a resubmission. In this version I have:
6+
7+
* I've fixed the LICENSE file to fit the template at <https://www.r-project.org/Licenses/MIT>
8+
* Fixed the http://www.stubhub.com/ url
9+
* Fixed url's for CRAN packages to be in canonical form
10+
* Re-ran roxygen on bechdel.Rmd vignette
11+
* Fixed description section of DESCRIPTION file
12+
13+
314
## Test environments
415

516
* local OS X install, R 3.3.2

man/nfltix_div_avgprice.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/nfltix_usa_avg.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/bechdel.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<meta name="author" content="Albert Y. Kim, Chester Ismay, and Jennifer Chunn" />
1414

15-
<meta name="date" content="2017-01-07" />
15+
<meta name="date" content="2017-01-08" />
1616

1717
<title>Bechdel analysis using the tidyverse</title>
1818

@@ -70,7 +70,7 @@
7070

7171
<h1 class="title toc-ignore">Bechdel analysis using the <code>tidyverse</code></h1>
7272
<h4 class="author"><em>Albert Y. Kim, Chester Ismay, and Jennifer Chunn</em></h4>
73-
<h4 class="date"><em>2017-01-07</em></h4>
73+
<h4 class="date"><em>2017-01-08</em></h4>
7474

7575

7676

vignettes/fivethirtyeight.Rmd

+7-6
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ library(knitr)
1818

1919
## Motivation
2020

21-
We are all involved in statistics and data science education, in particular at the
21+
We are involved in statistics and data science education, in particular at the
2222
introductory undergraduate level. As such, we are always looking for data sets that
2323
balance being
2424

25-
1. **Rich enough** to answer meaningful questions with, **real enough** to ensure that there is context, and **realistic enough** to convey to students that data as it exists "in the wild" needs processing.
25+
1. **Rich enough** to answer meaningful questions with, **real enough** to ensure that there is context, and **realistic enough** to convey to students that data as it exists "in the wild" often needs processing.
2626
1. Easily and quickly accessible to novices, so that we [minimize the prerequisites to research](https://arxiv.org/abs/1507.05346).
2727

2828
It has been our experience that many data sets that exist in R packages, such as the
@@ -31,15 +31,15 @@ It has been our experience that many data sets that exist in R packages, such as
3131
packages, are of great pedagogical value as they:
3232

3333
* Satisfy the above two goals.
34-
* Are in standardized format as they fit into the [tidy tools](https://cran.r-project.org/web/packages/tidyverse/vignettes/manifesto.html) ecosystem.
34+
* Are in standardized format as they fit into the [tidy tools](https://CRAN.R-project.org/package=tidyverse/vignettes/manifesto.html) ecosystem.
3535
* Are really fun to play with!
3636

3737
It is along these lines that we present `fivethirtyeight`: an R package of data and code behind the stories and interactives at [FiveThirtyEight.com](http://fivethirtyeight.com/), a data-driven journalism website founded by Nate Silver and owned by ESPN. FiveThirtyEight has been very forward thinking in making the data used in many of their articles open and accessible on [GitHub](https://github.com/fivethirtyeight/data), a web-based repository for collaboration on code and data.
3838

3939
With consultation from [Andrew Flowers](http://fivethirtyeight.com/contributors/andrew-flowers/) and [Andrei Scheinkman](http://fivethirtyeight.com/contributors/andrei-scheinkman/) of FiveThirtyEight, we go one step further by:
4040

41-
1. Doing just enough pre-processing so that statistics and data science novices can sink their teeth into the data.
42-
2. Packaging it all in an easy to load format: package installation instead of working with CSV's.
41+
1. Doing just enough pre-processing so that statistics and data science novices can sink their teeth into the data right away.
42+
2. Packaging it all in an easy to load format: package installation instead of working with CSV files.
4343
3. Providing easily accessible documentation: The help file for each data set includes a thorough description of the observational unit and all variables, a link to the original article, and (if listed) the data sources.
4444

4545

@@ -63,9 +63,10 @@ guidelines:
6363
+ Factors vs characters:
6464
+ Ordinal categorical variables are `factor` with the intuitive ordering of `levels`. We did this to ensure barplots and boxplots would display in an intuitive order.
6565
+ Regular categorical variables are left as `character` vectors.
66-
+ Convert date variables that are beyond just `year` to [POSIX date](http://www.epochconverter.com/) objects using the [lubridate](https://cran.r-project.org/web/packages/lubridate/vignettes/lubridate.html) package. That way users can easily create time series plots. Example:
66+
+ Convert date variables that are beyond just `year` to [POSIX date](http://www.epochconverter.com/) objects using the [lubridate](https://CRAN.R-project.org/package=lubridate/vignettes/lubridate.html) package. That way users can easily create time series plots. Example:
6767
+ If only a `year` variable exits, then we leave it as is.
6868
+ If there are `year` and `month` variables, we convert them POSIX date objects as `year-month-01`.
69+
+ If there are `year`, `month`, and `day` variables, we convert them POSIX date objects as `year-month-day`.
6970

7071
**Note**: The code used to pre-process the data can be found on the [GitHub repository](https://github.com/rudeboybert/fivethirtyeight/tree/master/data-raw) for the package in the `process_data_sets.R` files. These can serve as data manipulation/wrangling examples and exercises for more advanced students.
7172

vignettes/fivethirtyeight.html

+9-8
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<meta name="author" content="Albert Y. Kim, Chester Ismay, and Jennifer Chunn" />
1414

15-
<meta name="date" content="2017-01-07" />
15+
<meta name="date" content="2017-01-08" />
1616

1717
<title>fivethirtyeight Package</title>
1818

@@ -32,28 +32,28 @@
3232

3333
<h1 class="title toc-ignore"><code>fivethirtyeight</code> Package</h1>
3434
<h4 class="author"><em>Albert Y. Kim, Chester Ismay, and Jennifer Chunn</em></h4>
35-
<h4 class="date"><em>2017-01-07</em></h4>
35+
<h4 class="date"><em>2017-01-08</em></h4>
3636

3737

3838

3939
<div id="motivation" class="section level2">
4040
<h2>Motivation</h2>
41-
<p>We are all involved in statistics and data science education, in particular at the introductory undergraduate level. As such, we are always looking for data sets that balance being</p>
41+
<p>We are involved in statistics and data science education, in particular at the introductory undergraduate level. As such, we are always looking for data sets that balance being</p>
4242
<ol style="list-style-type: decimal">
43-
<li><strong>Rich enough</strong> to answer meaningful questions with, <strong>real enough</strong> to ensure that there is context, and <strong>realistic enough</strong> to convey to students that data as it exists “in the wild” needs processing.</li>
43+
<li><strong>Rich enough</strong> to answer meaningful questions with, <strong>real enough</strong> to ensure that there is context, and <strong>realistic enough</strong> to convey to students that data as it exists “in the wild” often needs processing.</li>
4444
<li>Easily and quickly accessible to novices, so that we <a href="https://arxiv.org/abs/1507.05346">minimize the prerequisites to research</a>.</li>
4545
</ol>
4646
<p>It has been our experience that many data sets that exist in R packages, such as the <a href="https://github.com/hadley/nycflights13"><code>nycflights13</code></a>, <a href="https://github.com/hadley/babynames"><code>babynames</code></a>, and <a href="https://github.com/jennybc/gapminder"><code>gapminder</code></a> packages, are of great pedagogical value as they:</p>
4747
<ul>
4848
<li>Satisfy the above two goals.</li>
49-
<li>Are in standardized format as they fit into the <a href="https://cran.r-project.org/web/packages/tidyverse/vignettes/manifesto.html">tidy tools</a> ecosystem.</li>
49+
<li>Are in standardized format as they fit into the <a href="https://CRAN.R-project.org/package=tidyverse/vignettes/manifesto.html">tidy tools</a> ecosystem.</li>
5050
<li>Are really fun to play with!</li>
5151
</ul>
5252
<p>It is along these lines that we present <code>fivethirtyeight</code>: an R package of data and code behind the stories and interactives at <a href="http://fivethirtyeight.com/">FiveThirtyEight.com</a>, a data-driven journalism website founded by Nate Silver and owned by ESPN. FiveThirtyEight has been very forward thinking in making the data used in many of their articles open and accessible on <a href="https://github.com/fivethirtyeight/data">GitHub</a>, a web-based repository for collaboration on code and data.</p>
5353
<p>With consultation from <a href="http://fivethirtyeight.com/contributors/andrew-flowers/">Andrew Flowers</a> and <a href="http://fivethirtyeight.com/contributors/andrei-scheinkman/">Andrei Scheinkman</a> of FiveThirtyEight, we go one step further by:</p>
5454
<ol style="list-style-type: decimal">
55-
<li>Doing just enough pre-processing so that statistics and data science novices can sink their teeth into the data.</li>
56-
<li>Packaging it all in an easy to load format: package installation instead of working with CSV’s.</li>
55+
<li>Doing just enough pre-processing so that statistics and data science novices can sink their teeth into the data right away.</li>
56+
<li>Packaging it all in an easy to load format: package installation instead of working with CSV files.</li>
5757
<li>Providing easily accessible documentation: The help file for each data set includes a thorough description of the observational unit and all variables, a link to the original article, and (if listed) the data sources.</li>
5858
</ol>
5959
</div>
@@ -74,10 +74,11 @@ <h2>Guidelines</h2>
7474
<li>Ordinal categorical variables are <code>factor</code> with the intuitive ordering of <code>levels</code>. We did this to ensure barplots and boxplots would display in an intuitive order.</li>
7575
<li>Regular categorical variables are left as <code>character</code> vectors.</li>
7676
</ul></li>
77-
<li>Convert date variables that are beyond just <code>year</code> to <a href="http://www.epochconverter.com/">POSIX date</a> objects using the <a href="https://cran.r-project.org/web/packages/lubridate/vignettes/lubridate.html">lubridate</a> package. That way users can easily create time series plots. Example:
77+
<li>Convert date variables that are beyond just <code>year</code> to <a href="http://www.epochconverter.com/">POSIX date</a> objects using the <a href="https://CRAN.R-project.org/package=lubridate/vignettes/lubridate.html">lubridate</a> package. That way users can easily create time series plots. Example:
7878
<ul>
7979
<li>If only a <code>year</code> variable exits, then we leave it as is.</li>
8080
<li>If there are <code>year</code> and <code>month</code> variables, we convert them POSIX date objects as <code>year-month-01</code>.</li>
81+
<li>If there are <code>year</code>, <code>month</code>, and <code>day</code> variables, we convert them POSIX date objects as <code>year-month-day</code>.</li>
8182
</ul></li>
8283
</ul></li>
8384
</ul>

0 commit comments

Comments
 (0)