% Generated by roxygen2: do not edit by hand

% Please edit documentation in R/gsplot-class.R

\name{gsplot}

\alias{gsplot}

\alias{gsplot.default}

\alias{gsplot.list}

\title{gsplot}

\usage{

gsplot(x = NULL, ...)

\method{gsplot}{default}(..., created = Sys.Date(),

gsplot.version = packageDescription(getPackageName(), fields = "Version"),

config.file = NA, theme = NA, frame.plot = TRUE)

\method{gsplot}{list}(x)

}

\arguments{

\item{x}{list}

\item{\dots}{Further graphical parameters may also be supplied as arguments. See 'Details'.}

\item{created}{vector of length one giving the date the gsplot object was created. Defaults to

using \code{Sys.Date()}. Output class matches that of the input.}

\item{gsplot.version}{vector of length one giving the version of the gsplot package used to create the

object. Defaults to calling \code{packageDescription()}. Output class matches that of the input.}

\item{config.file}{path to the file that will only be used for setting

par in this one gsplot object. If \code{NA} (default), par is set by the global options set by

load_config().}

\item{theme}{There are several built in themes (see \link{Themes}). Additionally, the user can create a \code{gsplot}

object in their workspace. This argument then takes the name of that object (either built-in or custom).

If \code{NA} (default), no theme is used.}

\item{frame.plot}{a logical indicating whether a box should be drawn around the plot. Default is \code{TRUE}.}

}

\value{

}

\description{

Used to change the class of inputs to "gsplot".

}

\examples{

gsplot()

gsplot(theme = theme.hadley)

gs_config <- gsplot(config.file =

system.file("extdata", "lineScatter.yaml", package = "gsplot")) \%>\%

lines(1:10, 1:10)

gs <- gsplot(theme = theme.hadley) \%>\%

points(1:10, 1:10, xlab="Index")

}