add layer

Description

add layer from gg object

Usage

## S3 method for class 'gg'
e1 + e2

Arguments

Value

gg

remove layer

Description

remove layer from gg object

Usage

## S3 method for class 'gg'
e1 - e2

Arguments

Value

gg

aesColor

Description

ColorInput UI production for discrete variables.

Usage

aesColour(type, session = NULL)

Arguments

Value

UI object

aesColorCont

Description

ColorInput UI production for continuous variables.

Usage

aesColourCont(type, session = NULL)

Arguments

Value

UI object

aesSelect

Description

SelectizeInput UI production for palletes.

Usage

aesSelect(type, session = NULL)

Arguments

Value

UI object

aesSlide

Description

sliderInput UI production for continuous variables

Usage

aesSlide(type, session = NULL)

Arguments

Value

UI object

arg.value

Description

Creates list of arguments and values in gg layer.

Usage

arg.value(item, obj.elems, session = NULL)

Arguments

Value

list

Try to coerce a ggplot object into a ggedit object

Description

Applied to ggplot objects to use the ploting function of ggedit.

Usage

as.ggedit(plot)

Arguments

Value

an object of class ggedit

See Also

print.ggedit, ggplot

Examples

p  <- ggplot2::ggplot(iris,ggplot2::aes(x =Sepal.Length,y=Sepal.Width))

p1 <- p + 
ggplot2::geom_point(ggplot2::aes(colour=Species)) + 
ggplot2::geom_line()

p2 <- p + 
ggplot2::geom_point() + 
ggplot2::geom_smooth(method='loess')

p3 <- list(p1,p2)

p4 <- as.ggedit(p3)

p4

recasts to gglist

Description

adds gglist class to object

Usage

as.gglist(plot)

## S3 method for class 'gglist'
as.gglist(plot)

## S3 method for class 'list'
as.gglist(plot)

## S3 method for class 'ggplot'
as.gglist(plot)

## S3 method for class 'ggmatrix'
as.gglist(plot)

Arguments

Value

gglist object

class_layer

Description

Determines the class of the arguments in a gg layer.

Usage

class_layer(p)

Arguments

Value

data.frame

Clone ggplot facet object

Description

Clone ggplot facet object and return either a gg object or the script to parse and evaluate

Usage

cloneFacet(obj, verbose = FALSE)

Arguments

Value

gg object or script

Examples

 obj <- ggplot2::facet_grid(
            rows = vars("a", "b"), cols = vars("c", "d"),
            scales = 'free', as.table = FALSE, switch = 'x', shrink = FALSE
        )

 cloneFacet(obj)
 cloneFacet(obj, verbose = TRUE)

Creates an independent copy of a ggplot layer object

Description

Creates copies of ggplot layers from within ggplot objects that are independent of the parent object.

Usage

cloneLayer(l, verbose = FALSE, showDefaults = TRUE)

Arguments

Details

ggplot objects are comprimsed of layer objects. Once compiled they are part of the plot object environment and if they are changed internally regardless of where they are in the (ie different environment) it will change the original plot. This function allows to create replicates of the plot layers and edit them independent of the original plot. When setting verbose to TRUE function returns the ggplot2 call as a string to paste in regular ggplot script to generate the layer.

Value

ggproto or string object (conditional on verbose)

Examples

p <- ggplot2::ggplot(iris,ggplot2::aes(x =Sepal.Length,y=Sepal.Width))

p <- p + 
ggplot2::geom_point(ggplot2::aes(colour='Species')) + 
ggplot2::geom_line()

p$layers[[1]]

newLayer <- cloneLayer(l=p$layers[[1]])

(v <- cloneLayer(l=p$layers[[1]],verbose=TRUE))

eval(parse(text=v))

clone root of ggplot object

Description

clone root of ggplot object and return either a new gg object or a string to parse and evaluate

Usage

cloneRoot(obj, verbose = FALSE)

Arguments

Value

gg object or script

See Also

capture.output

Examples

 cloneRoot(pList$pointSmooth)
 cloneRoot(pList$pointSmooth,verbose=TRUE)

Clone ggplot2 scales from compiled ggplot objects

Description

Clone ggplot2 scales from compiled ggplot objects returns not the original call but the nested call

Usage

cloneScales(p, verbose = FALSE)

Arguments

Value

ggplot scale or script (depends on verbose)

Examples

 # p <- pList$pointSmooth+scale_colour_continuous(low='red')
 # p
 # pList$pointSmooth+cloneScales(p)

compare

Description

Compare differences theme object e1 (new theme) to theme object e2 (old theme)

Usage

compare(e1, e2, verbose = TRUE)

Arguments

Value

theme object or character depending on verbose

Examples

compare(ggplot2::theme_bw(),ggplot2::theme_get())
compare(ggplot2::theme_bw(),ggplot2::theme_get(),verbose=FALSE)

Convert ggplot object to a string call

Description

Convert ggplot object to a string call

Usage

dput.ggedit(obj, file = "")

Arguments

Value

character

Examples

 pList$pointSmooth #original compiled plot
 
 this.gg <- dput.ggedit(pList$pointSmooth) #dput the plot
 
 writeLines(this.gg) #show the output
 
 eval(parse(text=this.gg)) #recompile the plot

 #add theme change
 p <- pList$pointSmooth+theme(panel.background = element_rect(fill='green'))
 
 this.gg<-dput.ggedit(p) #dput the plot
 
 writeLines(this.gg) #show the output
 
 eval(parse(text=this.gg)) #recompile the plot

fetch_aes_ggplotBuild

Description

Converts ggplot layers to list.

Usage

fetch_aes_ggplotBuild(p, geom_list)

Arguments

fetch_layer_aes

Description

Checks the aesthetics in a layer for internal use only.

Usage

fetch_layer_aes(
  self,
  data = data.frame(x = 1),
  params = list(),
  stats = list()
)

geom_list

Description

Returns character vector of geom types in ggplot.

Usage

geom_list(p)

Arguments

Value

character vector

ggEditUI

Description

The UI for the ggedit module.

Usage

ggEditUI(id)

Arguments

ggEdit

Description

The ggedit module.

Usage

ggEdit(
  input,
  output,
  session,
  obj,
  verbose = TRUE,
  showDefaults = FALSE,
  width = "auto",
  height = "auto"
)

Arguments

retreive all functions that create ggroto layers or stats

Description

Retreive all functions that create ggroto layers or stats

Usage

gg_session(gg_pkg = NULL)

Arguments

Value

data.frame

Examples

gg_session('ggplot2')

Backcheck what functions created the layers in a ggplot2 plot object

Description

Validate geoms with their unique attributes

Usage

gg_vetting(p, obj = ggedit_opts$get("session_geoms"))

Arguments

Value

data.frame

Examples

gg_vetting(pList$boxplotWrap)
lapply(pList,gg_vetting)

Interactive shiny gadget for editing ggplot layers and themes.

Description

Shiny gadget that takes an input ggplots and populates a user interface with objects that let the user update aesthetics of layers and theme elements.

Usage

ggedit(p.in, ...)

Arguments

Details

The user can start the gadget using the console ggedit(plotobj) or through the Addins menu in Rstudio.

If you are using the the Addin option highlight on the editor window the ggplot object and then click the addin.

Options to pass to ggedit

viewer shiny viewer options. It can be either paneViewer (default with minHeight=1000), dialogViewer, browserViewer

verbose logical to control if the output includes script for layers and themes calls for parsing to create objects (default, verbose=TRUE)

showDefaults toggle to control if the verbose output shows all the input arguments passed to the proto object (if verbose==FALSE then ignored)

width,height dimensions of the renderPlot where the active plot is displayed

Once the gadget is running the list of plots are shown in a grid and a number of objects will appear above them.

Action buttons

Cancel:

Returns a NULL object

Done:

Returns the list decribed below.

Dropdown list

Navigates through the plots in the input list. If the input list is a named list the names will be in the dropdown. The plot chosen is termed as the "active plot"

Radio buttons

The options to choose in the radio buttons are the layer names in the active plot.

Links

Update Plot Layer:

A pop up window will appear and be populated with aesthetic elements found in the layer chosen from the radio buttons. The layer is cloned using cloneLayer creating a layer independent of the original plot. If the aesthetic is a factor the values will be shown in dropdown lists. If it is numeric it will be shown in a slider. If it is a factor colour/fill aesthetic the colourPicker package will allow to choose from the full pallete of colours. If the continuous colour/fill aesthetic a dropdown list will be shown with different palletes

Update Plot Theme:

A popup modal will appear populated with the theme elements found in the active plot. Each element will appear as having a value or empty depending if it was defined or not. The user can change or fill in any element with valid values and any textboxes left empty will use ggplot defaults.

Update Grid Theme:

Copies the theme of the active plot to the other plots in the list

Update Global Theme:

Copies the theme of the active plot to the session theme and all plots created outside of the gadget will have this theme.

View Layer Code:

Opens an ace editor to compare the active layer initial script call and the updated script call.

The ggplot objects returned (layers and themes) can be used on any ggplot object.

Value

List of elements

updatedPlots

list containing updated ggplot objects

updatedLayers

For each plot a list of updated layers (ggproto) objects

UpdatedLayersElements

For each plot a list elements and their values in each layer

UpdatedLayerCalls

For each plot a list of scripts that can be run directly from the console to create a layer

updatedScales

For each plot a list of updated scale objects

UpdatedScalesCalls

For each plot a list of scripts that can be run directly from the console to create a scale object

updatedThemes

For each plot a list of updated theme objects

UpdatedThemeCalls

For each plot a list of scripts that can be run directly from the console to create a theme

See Also

cloneLayer,rgg,ggplot,colourPicker

Examples

p <- ggplot2::ggplot(iris,ggplot2::aes(x =Sepal.Length,y=Sepal.Width))

p <- p + 
ggplot2::geom_point(ggplot2::aes(colour=Species)) + 
ggplot2::geom_line()

if(interactive()){
## Not run: 
pnew <- ggedit(p)
pnew

## End(Not run)
}

Default and current ggedit options

Description

Options for functions in the ggedit package. When running R code, the object ggedit_opts (default options) is not modified by chunk headers (local chunk options are merged with default options), whereas ggedit_opts_current (current options) changes with different chunk headers and it always reflects the options for the current chunk.

Normally we set up the global options once in the first code chunk in a document using ggedit_opts$set(), so that all latter chunks will use these options. Note the global options set in one chunk will not affect the options in this chunk itself, and that is why we often need to set global options in a separate chunk.

Usage

ggedit_opts

ggedit_opts_current

Format

An object of class list of length 5.

An object of class list of length 5.

Note

ggedit_opts_current is read-only in the sense that it does nothing if you call ggedit_opts_current$set(); you can only query the options via ggedit_opts_current$get().

Examples

ggedit_opts$get('themeDefaultClass')

gggsave

Description

Wrapper of ggsave that saves ggplot or list of ggplot objects to image or pdf.

Usage

gggsave(filename = "Rplot.pdf", plot = last_plot(), ...)

Arguments

Details

default output is to create one pdf regardless of size of list of plots inputted

Value

nothing

Examples

## Not run: gggsave(pList)

is.NullOb

Description

Checks if any columns have a null in them.

Usage

is.NullOb(x)

Arguments

Value

logical

Is the object of class ggedit

Description

Is the object of class ggedit. Very basic for many functions in the package.

Usage

is.ggedit(x)

Arguments

Value

logical - is the object of class ggedit

gglist

Description

Checks if object is a gglist object

Usage

is.gglist(x)

Arguments

Value

boolean

layersList

Description

Runs the ggplot_build function on the input and converts the output data objects into a nested list with the unique values of each of the aesthetic columns.

Usage

layersList(obj)

Arguments

Value

list of aesthetics and their values for each layer in a plot

Examples

p=ggplot2::ggplot(iris,ggplot2::aes(x=Sepal.Length,y=Sepal.Width))
p=p+ggplot2::geom_point(ggplot2::aes(colour=Species))+ggplot2::geom_line()
p
p.list=layersList(p)
p.list

layersListFull

Description

Runs the ggplot_build function on the input and converts the output data objects into a nested list with the unique values of each of the aesthetic columns. Includes all objects used for theme plots

Usage

layersListFull(obj)

Arguments

Value

list of aesthetics and their values for each layer in a plot

layersListObj

Description

return named list for gg layers

Usage

layersListObj(obj, lbl)

List of plots for ggedit examples

Description

List of ggplot objects for examples in ggedit.

Usage

pList

Format

An object of class "list"

Details

list includes a geom_point, geom_point+facet_wrap, geom_boxplot+facet_wrap, geom_point+geom_line, geom_point+geom_smooth, geom_point+geom_line+facet_wrap, geom_point+geom_line+facet_grid

Print ggedit objects

Description

Plots lists of ggplot2 plot objects layout functionality.

Usage

## S3 method for class 'ggedit'
print(x, layout = NULL, byrow = FALSE, ...)

Arguments

Examples

p <- as.gglist(pList[1:2])
p

p1 <- p+geom_hline(aes(yintercept=3))
p1

print(p1,byrow=TRUE)

print(p1,layout = matrix(c(2,2,NA,1),ncol=2))

print.gglist

Description

Print method for gglist objects.

Usage

## S3 method for class 'gglist'
print(x, ...)

ggplot2 layer proto extraction

Description

Extract geom, stat and position protos from a ggplot2 layer

Usage

proto_features(l)

Arguments

Value

data.frame

Examples

proto_features(ggplot2::geom_smooth())
proto_features(ggplot2::annotation_logticks())

Remove a layer from a compiled ggplot2 object.

Description

Removes specified layers from a ggplot object.

Usage

remove_geom(p, geom, idx = NULL)

Arguments

Examples

p <- ggplot2::ggplot(iris,ggplot2::aes(x =Sepal.Length,y=Sepal.Width))
p <- p+ggplot2::geom_point(ggplot2::aes(colour=Species))+ggplot2::geom_line()
p
pnew <- p |> remove_geom('point',1)
pnew

Remove and replace ggplot2 layers.

Description

Removes specified layers from a ggplot object and gives the option to replace them with a new layer. This layer can be either a geom object created from regular ggplot functions or an output from the ggedit gadget. In the latter case the layers are found in the updatedLayers object in the ggedit output.

Usage

rgg(p, oldGeom, oldGeomIdx = 1, newLayer = NULL)

Arguments

Examples

p <- ggplot2::ggplot(iris,ggplot2::aes(x =Sepal.Length,y=Sepal.Width))

p <- p+ggplot2::geom_point(ggplot2::aes(colour=Species))+ggplot2::geom_line()

p

p |> rgg('point',1)

if( interactive() ){
x <- ggedit(p)
pnew <- p |> rgg('point',1,x$updatedLayers[[1]])
pnew
}

rmNullObs

Description

Removes null objects from a nested list.

Usage

rmNullObs(x)

Arguments

Value

list

Print to console verbose outputs of objects of class ggedit

Description

function to tidy the ggedit output to single script calls for each plot

Usage

## S3 method for class 'ggedit'
summary(object, ...)

Arguments

Details

use show.structure (boolean) to control if the output shows the full data.frame structure or just a placeholder [data.frame], Default: FALSE

themeFetch

Description

returns a nested list of a gg theme object, for ggedit gadget or module.

Usage

themeFetch(a = theme_get())

Arguments

Value

list

themeFetchFull

Description

Returns a nested list of all elements in gg theme object, for plot.theme plot.

Usage

themeFetchFull(a = theme_get())

Arguments

Value

list

themeListDepth

Description

Returns depth of nested list.

Usage

themeListDepth(this, thisdepth = 0)

Arguments

Value

numeric

themeMakePanel

Description

BS modal production for the gg theme.

Usage

themeMakePanel(x, y = NULL, session = NULL)

Arguments

Value

UI

themeNewVal

Description

Updates theme with new values from the module UIs.

Usage

themeNewVal(this, p.new, input)

themePanel

Description

UI production for the gg theme.

Usage

themePanel(obj.in, obj.name, session = NULL)

Arguments

Value

UI

vplayout

Description

Viewport with layout.

Usage

vplayout(x, y)

Arguments

Value

viewport