class_catalogue: View the objects in a class

In Don-Li/CAB_original:

Description

This function class_catalogue is for getting the names of objects from a specified class. It is most useful for when you want to view the objects that you have defined. For example, the make.custom_input function should be used to define inputs with unique names. class_catalogue can be used to check if your custom input names are unique.

Usage

class_catalogue(class_name, custom_env = NULL)

Arguments

class_name	A string that gives the name of the class that you want to view the objects of.
environment	A character vector that gives the environments that you want to search for objects in. The default value is NULL and by default, the class_catalogue searches through the global environment and also the CAB:package environment.

Value

Returns a character vector containing the names of all the instances of the class of interest.

Examples

# Make a test class
test_input = make.custom_input( name = "test_input" )
# Check that it exists
class_catalogue( "input" )

Don-Li/CAB_original documentation built on May 6, 2019, 2:53 p.m.