RM_list: Return the list of results managment of an object.

In HelpersMG: Tools for Environmental Analyses, Ecotoxicology and Various R Functions

Return the list of results managment of an object.

Description

RM_list returns the list of results managment of an object.

Usage

RM_list(
  x = stop("An object with results managment must be provided"),
  RM = "RM",
  silent = FALSE,
  max.level = FALSE
)

Arguments

x	The object to add a results managment
RM	The name of results managment stored
silent	Should the results be shown ?
max.level	If TRUE, will return all list element of the objects

Details

RM_list returns the list of results managment of an object

Value

A list with the names of results stored in an object

Author(s)

Marc Girondot [e-mail]

See Also

Other Results Managment: RM_add(), RM_delete(), RM_duplicate(), RM_get()

Examples

## Not run: 
library("HelpersMG")
# Let an object of class objclass being created
obj <- list(A=100, name="My object")
class(obj) <- "objclass"
# And now I create a RM to this object
obj <- RM_add(x=obj, RMname="NewAnalysis1")
RM_list(obj)
obj <- RM_add(x=obj, RMname="NewAnalysis2")
RM_list(obj)
obj <- RM_add(x=obj, RMname="NewAnalysis2", valuename="V1", value=100)
RM_get(x=obj, RMname="NewAnalysis2", valuename="V1")
obj <- RM_add(x=obj, RMname="NewAnalysis2", valuename="V1", value=200)
RM_get(x=obj, RMname="NewAnalysis2", valuename="V1")
obj <- RM_add(x=obj, RMname="NewAnalysis2", valuename="V2", value=300)
RM_get(x=obj, RMname="NewAnalysis2", valuename="V2")
RM_list(obj)
rmlist <- RM_list(obj, max.level=TRUE)
rmlist

## End(Not run)

HelpersMG documentation built on Oct. 5, 2023, 5:08 p.m.