Record {laminr}R Documentation

Record

Description

A record from a registry.

Methods

Public 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
Record$new(instance, registry, api, data)
Arguments
instance

The instance the record belongs to.

registry

The registry the record belongs to.

api

The API for the instance.

data

The data for the record.


Method delete()

Delete a Record

Usage
Record$delete(verbose = FALSE)
Arguments
verbose

Whether to print details of the API call

Returns

TRUE invisibly if the deletion is successful


Method print()

Print a Record

Usage
Record$print(style = TRUE)
Arguments
style

Logical, whether the output is styled using ANSI codes


Method to_string()

Create a string representation of a Record

Usage
Record$to_string(style = FALSE)
Arguments
style

Logical, whether the output is styled using ANSI codes

Returns

A cli::cli_ansi_string if style = TRUE or a character vector


[Package laminr version 0.3.0 Index]