refreshEntityS4Class: Refresh Entity S4 class definition

In agower/GeneHive: R interface to a GeneHive

Refresh Entity S4 class definition

Description

This function refreshes the local S4 class definition corresponding to a given Entity class.

Usage

refreshEntityS4Class(class, verbose = getOption("GeneHive.verbose"))

Arguments

class	A character string specifying the Entity class
verbose	Logical value specifying whether messages should be printed

Details

• If the S4 class definition does not exist, it will be set in the .GlobalEnv environment.

• If the S4 class definition exists in one namespace, is unsealed, and does not match the current EntityClass definition, it will be refreshed.

• If the S4 class definition exists in two namespaces, one of which is .GlobalEnv, the definition in .GlobalEnv will be removed. If the remaining definition is unsealed and does not match the current EntityClass definition, it will be refreshed.

Value

• If the S4 class definition is successfully set or refreshed, the corresponding hiveEntityClass S4 object containing the Entity class definition (invisibly).

• If the S4 class definition exists in two or more namespaces (not including .GlobalEnv) the function terminates with an error.

• If a single S4 class definition exists, but is sealed, the function terminates with an error.

Author(s)

Adam C. Gower [e-mail]

agower/GeneHive documentation built on April 14, 2022, 5:08 a.m.