A registry in a module.
Active bindings
module
(Module)
The instance the registry belongs to.name
(
character(1)
)
The API for the instance.class_name
(
character(1)
)
The class name for the registry.is_link_table
(
logical(1)
)
Whether the registry is a link table.
Methods
Method new()
Creates an instance of this R6 class. This class should not be instantiated directly,
but rather by connecting to a LaminDB instance using the connect()
function.
Usage
Registry$new(instance, module, api, registry_name, registry_schema)
Method get()
Get a record by ID or UID.
Arguments
id_or_uid
The ID or UID of the record.
include_foreign_keys
Logical, whether to include foreign keys in the record.
verbose
Logical, whether to print verbose output.
Returns
A Record object.
Method df()
Get a data frame summarising records in the registry
Method from_df()
Create a record from a data frame
Arguments
dataframe
The
data.frame
to create a record fromkey
A relative path within the default storage
description
A string describing the record
run
A
Run
object that creates the record
Method from_path()
Create a record from a path
Arguments
path
Path to create a record from
key
A relative path within the default storage
description
A string describing the record
run
A
Run
object that creates the record
Method from_anndata()
Create a record from an AnnData
Arguments
adata
The anndata::AnnData object to create a record from
key
A relative path within the default storage
description
A string describing the record
run
A
Run
object that creates the record
Method get_record_class()
Get the record class for the registry.
Note: This method is intended for internal use only and may be removed in the future.
Returns
A Record class.
Method get_temporary_record_class()
Get the temporary record class for the registry.
Note: This method is intended for internal use only and may be removed in the future.
Method print()
Print a Registry