Skip to content

Commit

Permalink
Build pkgdown site (#150)
Browse files Browse the repository at this point in the history
* Remove unnecessary noMd tags

* Rebuild documentation

* Add encoding to DESCRIPTION to remove roxygen2 warning

* Build pkgdown site
  • Loading branch information
Dana Paige Seidel authored and hadley committed Jul 23, 2018
1 parent 419236a commit 3c17ebf
Show file tree
Hide file tree
Showing 144 changed files with 15,283 additions and 36 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
^revdep$
^codecov\.yml$
^\.github$
^_pkgdown\.yml$
^docs$
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Description: Graphical scales map data to aesthetics, and provide
methods for automatically determining breaks and labels
for axes and legends.
License: MIT + file LICENSE
URL: https://github.com/r-lib/scales
URL: https://scales.r-lib.org, https://github.com/r-lib/scales
BugReports: https://github.com/r-lib/scales/issues
Depends:
R (>= 3.1)
Expand All @@ -31,3 +31,4 @@ LinkingTo:
LazyLoad: yes
Roxygen: list(markdown = TRUE)
RoxygenNote: 6.0.1.9000
Encoding: UTF-8
1 change: 0 additions & 1 deletion R/pal-dichromat.r
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#' Dichromat (colour-blind) palette (discrete).
#'
#' @noMd
#' @param name Name of colour palette. One of:
#' \Sexpr[results=rd,stage=build]{scales:::dichromat_schemes()}
#' @export
Expand Down
1 change: 0 additions & 1 deletion R/scale-continuous.r
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#' Continuous scale.
#'
#' @noMd
#' @param x vector of continuous values to scale
#' @param palette palette to use.
#'
Expand Down
1 change: 0 additions & 1 deletion R/trans.r
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
#' to breaks generated to the raw data.
#' @param domain domain, as numeric vector of length 2, over which
#' transformation is valued
#' @noMd
#' @seealso \Sexpr[results=rd,stage=build]{scales:::seealso_trans()}
#' @export trans_new is.trans
#' @aliases trans_new trans is.trans
Expand Down
74 changes: 74 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
reference:
- title: Scales basics
desc: >
Scales control the details of how data values are translated to visual
properties. The following functions help users create (and update)
custom scales.
contents:
- cscale
- dscale
- starts_with("train_")

- title: "Colour Palettes & Colour Mapping"
desc: >
Functions for specifying colour palettes, colour mapping, and
various helper functions.
contents:
- brewer_pal
- dichromat_pal
- div_gradient_pal
- gradient_n_pal
- grey_pal
- hue_pal
- seq_gradient_pal
- rescale_pal
- viridis_pal
- contains("col")
- muted
- alpha

- title: Non-Colour Palette functions
desc: >
Functions to help scale non-colour aesthetics.
contents:
- abs_area
- area_pal
- identity_pal
- linetype_pal
- manual_pal
- rescale_pal
- shape_pal

- title: Transformations
desc: >
Functions to describe common and custom scale transformations
and their inverses.
contents:
- matches("trans")
- -trans_breaks

- title: "Bounds: Ranges & Rescaling"
desc: >
Functions for rescaling values and adjusting scale ranges.
contents:
- starts_with("rescale")
- matches("range")
- squish
- squish_infinite
- expand_range
- discard
- censor

- title: Breaks
desc: >
Functions for computing scale breaks.
contents:
- matches("breaks")

- title: Label Formatters
desc: >
Functions for formatting nice labels.
contents:
- matches("format")


137 changes: 137 additions & 0 deletions docs/CODE_OF_CONDUCT.html

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

131 changes: 131 additions & 0 deletions docs/LICENSE-text.html

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

Loading

0 comments on commit 3c17ebf

Please sign in to comment.