+Demo workflow
+gsplot uses similar plotting graphics to R base graphics, but allows users to execute them in a more intuitive manner. Additionally, as the complexity of the plot features increase, gpslot code is simplistic compared to that of base graphics. gsplot also includes features not present in base graphics that are useful when working with USGS data, such as callouts (combines segments and text into a single call), error_bar (allows an error to be given as y.high, y.low, x.high, and x.low and automatically builds an error bar), and the argument legend.name (an argument within points, lines, etc. which does not require colors, linetypes, and other par information to be redefined within the legend call).
+
Fig. 1 Simple flow timeseries using gsplot.
+
Fig. 2 Simple flow timeseries with a logged y-axis using gsplot.
+
Fig. 3 (a) pH vs water temperature, (b) pH timeseries, (c) water temperature timeseries.
+
Fig. 4 Water temperature timeseries on primary y-axis with pH timeseries on secondary y-axis.
+
Fig. 5 Initial plot of water temperature timeseries.
# notice the missing data from ~ 1991 through ~2011 and add a callout
diff --git a/inst/extdata/lineScatter.yaml b/inst/extdata/lineScatter.yaml
index 64c8acd..1d2e4ee 100644
--- a/inst/extdata/lineScatter.yaml
+++ b/inst/extdata/lineScatter.yaml
@@ -16,7 +16,6 @@ lines:
col: "black"
lty: 1
lwd: 1
- labels: FALSE
abline:
col: "grey"
lty: 1
diff --git a/man/config.Rd b/man/config.Rd
index f5ea0b0..0062de9 100644
--- a/man/config.Rd
+++ b/man/config.Rd
@@ -4,7 +4,7 @@
\alias{config}
\title{Get configuration for gsplot}
\usage{
-config(type, ..., persist = FALSE)
+config(type, ..., persist = FALSE, custom.config = FALSE)
}
\arguments{
\item{type}{string of gsplot config object to retrieve}
@@ -12,6 +12,8 @@ config(type, ..., persist = FALSE)
\item{...}{additional configuration to override what is pulled from config}
\item{persist}{logical of whether to persist overrides to config}
+
+\item{custom.config}{logical of whether to use default global (FALSE) or a config set for only one gsplot object}
}
\description{
Gets config for gsplot, mostly used internally
diff --git a/man/filter_arguments.Rd b/man/filter_arguments.Rd
index c66a48a..6619f35 100644
--- a/man/filter_arguments.Rd
+++ b/man/filter_arguments.Rd
@@ -4,11 +4,13 @@
\alias{filter_arguments}
\title{extract the call arguments}
\usage{
-filter_arguments(fun.name, ...)
+filter_arguments(fun.name, ..., custom.config = FALSE)
}
\arguments{
\item{fun.name}{the name of the rendering function}
+\item{custom.config}{logical to use custom or global config file}
+
\item{\dots}{arguments to \code{fun.name} or an embedded function
within it.}
}
diff --git a/man/function_call_args.Rd b/man/function_call_args.Rd
index 713751d..64db6cf 100644
--- a/man/function_call_args.Rd
+++ b/man/function_call_args.Rd
@@ -4,11 +4,13 @@
\alias{function_call_args}
\title{get the arguments that go into the function call, stripping out others and adding config defaults}
\usage{
-function_call_args(fun.name, all.args)
+function_call_args(fun.name, all.args, custom.config = FALSE)
}
\arguments{
\item{fun.name}{the name of the rendering function}
+\item{custom.config}{logical whether or not to use custom.config or global config defaults}
+
\item{.dots}{lazy_dots arguments}
}
\description{
diff --git a/man/gsplot.Rd b/man/gsplot.Rd
index beb4c27..da81a43 100644
--- a/man/gsplot.Rd
+++ b/man/gsplot.Rd
@@ -8,13 +8,17 @@
\usage{
gsplot(x = NULL, ...)
-\method{gsplot}{default}(...)
+\method{gsplot}{default}(..., config.file = NA, theme = NA)
\method{gsplot}{list}(x)
}
\arguments{
\item{x}{list}
+\item{config.file}{path to config yaml for individual gsplot object}
+
+\item{theme}{path to theme}
+
\item{\dots}{Further graphical parameters may also be supplied as arguments. See 'Details'.}
}
\value{
diff --git a/man/load_temp_config.Rd b/man/load_temp_config.Rd
new file mode 100644
index 0000000..a6f98b2
--- /dev/null
+++ b/man/load_temp_config.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/config.R
+\name{load_temp_config}
+\alias{load_temp_config}
+\title{Load gsplot temporary config}
+\usage{
+load_temp_config(filename)
+}
+\arguments{
+\item{filename}{string to custom file}
+}
+\description{
+Loads the config file into options which are
+used elsewhere in the application. This will only change the config paremeters while
+building up the gsplot object, not on print.
+}
+
diff --git a/man/set_args.Rd b/man/set_args.Rd
index dc7ecff..3a7b21b 100644
--- a/man/set_args.Rd
+++ b/man/set_args.Rd
@@ -4,11 +4,13 @@
\alias{set_args}
\title{set argument list for a given function}
\usage{
-set_args(fun.name, ..., package = "graphics")
+set_args(fun.name, ..., custom.config = FALSE, package = "graphics")
}
\arguments{
\item{fun.name}{the name of the function to generate an arg list for}
+\item{custom.config}{logical}
+
\item{package}{the package to use to get the function from (defaults to 'graphics')}
\item{\dots}{user arguments to be used for the list}
diff --git a/tests/testthat/test-add_new_side.R b/tests/testthat/test-add_new_side.R
index d46f285..aa62cca 100644
--- a/tests/testthat/test-add_new_side.R
+++ b/tests/testthat/test-add_new_side.R
@@ -1,7 +1,7 @@
context("test add new side")
test_that("add new side", {
- obj <- list()
+ obj <- gsplot()
obj <- gsplot:::add_new_side(obj, 'side.1')
expect_true('side.1' %in% gsplot:::side_names(obj))
@@ -10,7 +10,7 @@ test_that("add new side", {
test_that("par defaults on new side", {
- obj <- list()
+ obj <- gsplot()
obj <- gsplot:::add_new_side(obj, 'side.1')
obj <- gsplot:::modify_side_par(obj, arguments =list(las='2'), side=1)
expect_true('par' %in% names(obj[['side.1']]))
@@ -18,7 +18,7 @@ test_that("par defaults on new side", {
test_that("axis defaults on new side", {
- obj <- list()
+ obj <- gsplot()
obj <- gsplot:::add_new_side(obj, 'side.1')
expect_true(all(c("lim", "log", "label", "usr.lim") %in% names(obj[['side.1']])))
expect_false(any(obj[['side.1']][['usr.lim']]))
diff --git a/tests/testthat/tests-config.R b/tests/testthat/tests-config.R
index 4dcac63..dde1db0 100644
--- a/tests/testthat/tests-config.R
+++ b/tests/testthat/tests-config.R
@@ -30,3 +30,27 @@ test_that("formals are correctly retrieved", {
test_that("non-existant type hits error", {
expect_error(config("foo"))
})
+
+test_that("config temp", {
+ df <- data.frame(x = 1:10, y=1:10, z = seq(2,20,2))
+
+ gsp <- gsplot(config.file = system.file("extdata", "lineScatter.yaml", package = "gsplot")) %>%
+ lines(df$x, df$y, col="red", legend.name = "points")
+ expect_true(gsp$global$config$config.file)
+
+ gspDef <- gsplot() %>%
+ lines(df$x, df$y, col="red", legend.name = "points")
+ expect_false(gspDef$global$config$config.file)
+
+ loadConfig(system.file("extdata", "lineScatter.yaml", package = "gsplot"))
+ gsp <- gsplot() %>%
+ lines(df$x, df$y, col="red", legend.name = "points")
+ expect_false(gsp$global$config$config.file)
+ expect_equal(gsp$side.1$axis$lwd, 0.8)
+
+ loadConfig()
+ gspDef2 <- gsplot() %>%
+ lines(df$x, df$y, col="red", legend.name = "points")
+ expect_false(gspDef2$global$config$config.file)
+ expect_null(gspDef2$side.1$axis$lwd)
+})