R Graphical Manual

Browse All

Last data update: 2014.03.03

R: General plot function for RLum S4 class objects

plot_RLum

R Documentation

General plot function for RLum S4 class objects

Description

Function calls object specific plot functions for RLum S4 class objects.

Usage

plot_RLum(object, ...)

Arguments

`object`	`RLum` (required): S4 object of class `RLum`. Optional a `list` containing objects of class `RLum` can be provided. In this case the function tries to plot every object in this list according to its `RLum` class.
`...`	further arguments and graphical parameters that will be passed to the specific plot functions. The only argument that is supported directly is `main` (setting the plot title). In contrast to the normal behaviour `main` can be here provided as `list` and the arguments in the list will dispatched to the plots if the `object` is of type `list` as well.

Details

The function provides a generalised access point for plotting specific RLum objects.
Depending on the input object, the corresponding plot function will be selected. Allowed arguments can be found in the documentations of each plot function.

object		corresponding plot function
`RLum.Data.Curve`	:	`plot_RLum.Data.Curve`
`RLum.Data.Spectrum`	:	`plot_RLum.Data.Spectrum`
`RLum.Data.Image`	:	`plot_RLum.Data.Image`
`RLum.Analysis`	:	`plot_RLum.Analysis`
`RLum.Results`	:	`plot_RLum.Results`

Value

Returns a plot.

Function version

0.4.2 (2016-05-02 09:36:06)

Note

The provided plot output depends on the input object.

Author(s)

Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)
R Luminescence Package Team

References

Examples



#load Example data
data(ExampleData.CW_OSL_Curve, envir = environment())

#transform data.frame to RLum.Data.Curve object
temp <- as(ExampleData.CW_OSL_Curve, "RLum.Data.Curve")

#plot RLum object
plot_RLum(temp)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(Luminescence)
Welcome to the R package Luminescence version 0.6.0 [Built: 2016-05-30 16:47:30 UTC]
A PhD supervisor: 'Live long and in prosper.'
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Luminescence/plot_RLum.Rd_%03d_medium.png", width=480, height=480)
> ### Name: plot_RLum
> ### Title: General plot function for RLum S4 class objects
> ### Aliases: plot_RLum
> ### Keywords: dplot
> 
> ### ** Examples
> 
> 
> 
> #load Example data
> data(ExampleData.CW_OSL_Curve, envir = environment())
> 
> #transform data.frame to RLum.Data.Curve object
> temp <- as(ExampleData.CW_OSL_Curve, "RLum.Data.Curve")
> 
> #plot RLum object
> plot_RLum(temp)
> 
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>