build

RichardJActon · Apr 30, 2021 · 28f939a · 28f939a
1 parent 9a296df
commit 28f939a
Show file tree

Hide file tree

Showing 7 changed files with 160 additions and 1 deletion.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,3 +1,5 @@
+^renv$
+^renv\.lock$
 ^colourScaleR\.Rproj$
 ^\.Rproj\.user$
 ^LICENSE\.md$
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 .Rdata
 .httr-oauth
 .DS_Store
+renv**
+.Rprofile
diff --git a/R/universal_colour_scaler.R b/R/universal_colour_scaler.R
@@ -268,7 +268,7 @@ universal_colour_scaler <- function(
 	} else if(scale == "log") {
 		breaks <- lseq(from = minx, to = maxx, length_out = n_breaks)
 	} else if(scale == "quantile") {
-		breaks <- quantile(
+		breaks <- stats::quantile(
 			x = x,
 			probs = seq(0, 1, length.out = n_breaks),
 			na.rm = TRUE

diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+
+# colourScaleR
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+`colourScaleR` provides a unified interface to [scico](https://github.com/thomasp85/scico), [viridis](https://github.com/sjmgarnier/viridis), & [Color Brewer](https://colorbrewer2.org) for creating colour scales
+
+## Installation
+
+You can install the development version of `colourScaleR` from [github](https://github.com/RichardJActon/colourScaleR) with:
+
+``` r
+remotes::install_github("RichardJActon/colourScaleR")
+```
+
+## Example
+
+``` r
+library(colourScaleR)
+
+universal_colour_scaler(
+	rnorm(10),
+	type = "brewer",
+	scale = "log",
+	palette = "RdYlBu",
+	verbose = TRUE,
+	n_breaks = 10,
+	mode = "scaled",
+	direction = -1
+)
+```
+
diff --git a/man/lseq.Rd b/man/lseq.Rd
diff --git a/man/range_check.Rd b/man/range_check.Rd
diff --git a/man/universal_colour_scaler.Rd b/man/universal_colour_scaler.Rd