Skip to content

Commit

Permalink
delete untracked files in inst/doc/ so taht vignettes will update whe…
Browse files Browse the repository at this point in the history
…n building package. fix outdated arguments in vignette example for guide_colorplane
  • Loading branch information
wmurphyrd committed Oct 4, 2016
1 parent 8250f48 commit 693bee9
Show file tree
Hide file tree
Showing 9 changed files with 66 additions and 37 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.Rproj.user
.Rhistory
.RData
inst/doc
vignettes/*.pdf
tests/*/*.pdf
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Package: colorplaner
Type: Package
Title: A ggplot2 Extension to Visualize Two Variables per Color Aesthetic
Through Color Space Projections
Version: 0.1.1
Date: 2016-09-20
Version: 0.1.2
Date: 2016-10-02
Authors@R: c(person("William", "Murphy",
email = "william.murphy.rd@gmail.com",
role = c("aut", "cre")),
Expand Down
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Version 0.1.2
* Fixed an issue that was preventing updated vignettes from building
* Complete versions of `colorplaner` and `other_projections` vignettes
now included

# Version 0.1.1
* Initial release of the colorplaner package
* Implements two new gglot2 scales: `scale_color_colorplane` and
Expand Down
20 changes: 16 additions & 4 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
## Resubmission
This is a resubmission. I have edited the description to remove the repetition
of the package title.
## Request for Early Update
This a request to update the colorplaner package shortly after initial
publication.

I am requesting this update because the published package contains
incomplete versions of the package vignettes. This occurred because I had
inadvertently left files in /inst/docs/ from previous test building of vignettes
and was unaware that this would prevent the current vignettes from being
built.

I have submitted a pull request for the devtools package to
add a check for this mistake to prevent it from happening to others:
https://github.com/hadley/devtools/pull/1362

I apologize for the inefficient use of CRAN volunteer and server resources.
Thank you for considering this early update.

## Test environments
* local Windows 10 install, R 3.3.1
Expand All @@ -11,7 +24,6 @@ of the package title.
There were no ERRORs or WARNINGs.

There is one NOTE for CRAN incoming feasibility:
* This is an initial submission for a new package.
* The spelling of the flagged words is as intended
* bivariate (correct)
* choropleth (correct)
Expand Down
Binary file modified figure/colorplane-advanced-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified figure/intro-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions makeReadme.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@
readme <- readLines("vignettes/colorplaner.Rmd")
loc <- grep("^---$", readme)

news_loc <- grep("^## Usage$", readme)[1] - 1
news_loc <- grep("^## Motivation$", readme)[1] - 1

ins <- c("# colorplaner",
"",
"[![BuildStatus](https://travis-ci.org/wmurphyrd/colorplaner.svg?branch=master)](https://travis-ci.org/wmurphyrd/colorplaner)",
"[![Coverage Status](https://coveralls.io/repos/github/wmurphyrd/colorplaner/badge.svg?branch=master)](https://coveralls.io/github/wmurphyrd/colorplaner?branch=master)",
"",
"[![CRAN Version](http://www.r-pkg.org/badges/version/colorplaner)](https://cran.r-project.org/package=colorplaner)",
"[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/grand-total/colorplaner)](https://cran.r-project.org/package=colorplaner)",
"```{r include = F}",
"knitr::opts_chunk$set(fig.width = 5, fig.height = 5)",
"```",
Expand All @@ -34,6 +35,9 @@ news_ins <- c("",
"To install:",
"",
"```{r, eval=FALSE}",
"# CRAN Version:",
"install.packages(\"colorplaner\")",
"# Current development version: ",
"devtools::install_github(\"wmurphyrd/colorplaner\")",
"```",
"",
Expand Down
55 changes: 32 additions & 23 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[![BuildStatus](https://travis-ci.org/wmurphyrd/colorplaner.svg?branch=master)](https://travis-ci.org/wmurphyrd/colorplaner)
[![Coverage Status](https://coveralls.io/repos/github/wmurphyrd/colorplaner/badge.svg?branch=master)](https://coveralls.io/github/wmurphyrd/colorplaner?branch=master)

[![CRAN Version](http://www.r-pkg.org/badges/version/colorplaner)](https://cran.r-project.org/package=colorplaner)
[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/grand-total/colorplaner)](https://cran.r-project.org/package=colorplaner)



Expand All @@ -13,6 +14,31 @@ well as other visualizations with bivariate color scales. The extension implemen

![Example use of colorplane with the iris dataset.](figure/intro-1.png)


## Installation

To install:


```r
# CRAN Version:
install.packages("colorplaner")
# Current development version:
devtools::install_github("wmurphyrd/colorplaner")
```

#### Version 0.1.2
* Fixed an issue that was preventing updated vignettes from building
* Complete versions of `colorplaner` and `other_projections` vignettes
now included

#### Version 0.1.1
* Initial release of the colorplaner package
* Implements two new gglot2 scales: `scale_color_colorplane` and
`scale_fill_colorplane`
* Implements one new ggplot2 guide: `guide_colorplane`


## Motivation

In _The Visual Display of Quantitative Information_, Edward Tufte praises
Expand Down Expand Up @@ -173,23 +199,6 @@ Both
are rendered as identically colored pixels, but the surrounding colors lead to
differing perceptions.


## Installation

To install:


```r
devtools::install_github("wmurphyrd/colorplaner")
```

#### Version 0.1.1
* Initial release of the colorplaner package
* Implements two new gglot2 scales: `scale_color_colorplane` and
`scale_fill_colorplane`
* Implements one new ggplot2 guide: `guide_colorplane`


## Usage

To implement color plane mapping in a `ggplot`, simply create aesthetic mappings to `color` and `color2` or `fill` and `fill2` and add the corresponding colorplane scale to the plot. The colorplane guide is added by default.
Expand Down Expand Up @@ -230,8 +239,8 @@ modified with the following changes:
4. Improve the guide titles (`axis_title`, `axis_title_y`, `title`)
3. Change the guide vertical axis labels to a percentage scale (`fill2`, `labels_y`)
4. Force the percentage scale to range from 0% to 100% (`limits_y`).
6. Duplicate guide labels on both sides (`label.position`, `label_y.position`)
6. Move the x-axis title between the guide title and upper labels (`axis_title.position`)
6. Duplicate guide labels on both sides (`label.position`, `label.y.position`)
6. Move the x-axis title between the guide title and upper labels (`axis.title.position`)

Additional options and details are described in the package documentation:
`?scale_color_colorplane` and `?guide_colorplane`.
Expand Down Expand Up @@ -260,10 +269,10 @@ if(require("maps")) {
title = "State Color Key",
title.theme = element_text(size = 13),
label.theme = theme_gray(),
label_y.theme = theme_gray(),
axis_title.position = "top",
label.y.theme = theme_gray(),
axis.title.position = "top",
label.position = c("top", "bottom"),
label_y.position = c("left", "right")))
label.y.position = c("left", "right")))
}
```

Expand Down
10 changes: 5 additions & 5 deletions vignettes/colorplaner.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,8 @@ modified with the following changes:
4. Improve the guide titles (`axis_title`, `axis_title_y`, `title`)
3. Change the guide vertical axis labels to a percentage scale (`fill2`, `labels_y`)
4. Force the percentage scale to range from 0% to 100% (`limits_y`).
6. Duplicate guide labels on both sides (`label.position`, `label_y.position`)
6. Move the x-axis title between the guide title and upper labels (`axis_title.position`)
6. Duplicate guide labels on both sides (`label.position`, `label.y.position`)
6. Move the x-axis title between the guide title and upper labels (`axis.title.position`)

Additional options and details are described in the package documentation:
`?scale_color_colorplane` and `?guide_colorplane`.
Expand Down Expand Up @@ -305,10 +305,10 @@ if(require("maps")) {
title = "State Color Key",
title.theme = element_text(size = 13),
label.theme = theme_gray(),
label_y.theme = theme_gray(),
axis_title.position = "top",
label.y.theme = theme_gray(),
axis.title.position = "top",
label.position = c("top", "bottom"),
label_y.position = c("left", "right")))
label.y.position = c("left", "right")))
}
```

0 comments on commit 693bee9

Please sign in to comment.