Package {eqty.sdk.r}

eqty.sdk.r: Verifiable Provenance for 'R' Workflows

Description

Provides an 'R' interface for building verifiable manifests around data, models, prompts, agents, computations, and related lineage. Exposes the public 'eqty-sdk' 'Python' package through types accessible from 'R' for creating assets, connecting computation inputs and outputs by content identifier, grouping statements in contexts, and exporting manifest JSON files.

An R interface for building integrity manifests around data, models, prompts, agents, computations, and their lineage. It exposes the Python 'eqty_sdk' API through R names such as [Dataset], [Context], and [Signer], loaded lazily through 'reticulate'.

Details

Start with [integrity_init()], which prepares the SDK's local state and returns a [Config]. A [Context] groups related assets, computations, and statements and defines what is written when that context is exported. Configure an active [Signer] before creating statements so they are attributed to its DID.

Assets represent tracked inputs and outputs. Create them from an R object, a file or directory path, or an existing [CID]. Use [integrity_compute()] to wrap an R function and capture its execution, or [Computation] when input and output CIDs need to be added explicitly.

The exported SDK classes are Python-backed and retain their method syntax. Use [integrity_path()] for methods that require a Python path and [integrity_dict()] for methods that require a Python dictionary.

Author(s)

Maintainer: Support EQTY Lab package-management@eqtylab.io

Authors:

• Support EQTY Lab package-management@eqtylab.io

See Also

Useful links:

• https://github.com/eqtylab/integrity-r

• https://eqtylab.github.io/integrity-py/latest/

• https://pypi.org/project/eqty-sdk/

• Report bugs at https://github.com/eqtylab/integrity-r/issues

Access the Python Compute Decorator

Description

Provides direct access to 'eqty_sdk.compute()'. R functions should usually use [integrity_compute()], which executes the R function directly and records its source and execution with [Code] and [Computation].

Usage

compute(...)

Arguments

Value

The Python compute decorator or decorated callable returned by the SDK.

Direct access to the Python SDK module

Description

'eqty' is retained for compatibility. Prefer the exported R names such as [Dataset], [Context], and [integrity_init()] for new code.

Value

A list of class eqty_sdk_proxy representing the Python eqty_sdk module. Accessing a member with $ loads the module and returns the requested Python object through reticulate. Python objects inherit from python.builtin.object; values that reticulate converts automatically are returned as the corresponding R values.

Examples

# The compatibility proxy can be inspected without initializing Python.
class(eqty)
stopifnot(inherits(eqty, "eqty_sdk_proxy"))

Python-backed Eqty SDK Types

Description

These names are lazy proxies for the matching 'eqty_sdk' classes and enums. They are available after 'library(eqty.sdk.r)' and resolve the installed Python SDK only when a member is accessed. They retain its constructors, factories, properties, and methods.

Details

The built-in asset categories are 'Agent', 'Benchmark', 'BenchmarkResult', 'Binary', 'Certificate', 'Code', 'Configuration', 'Credential', 'Custom', 'Database', 'Dataset', 'Document', 'Guardrail', 'Media', 'Model', 'Prompt', 'Reasoning', 'Skill', 'SystemPrompt', 'Token', and 'Tool'. They share a common construction pattern. Use 'with_context(ctx)' when the asset belongs to a specific context.

[CID] identifies content and is used to connect computation inputs and outputs. [UUID] identifies objects whose identity is not derived from their content. [DID] identifies signers and other entities referenced by provenance statements.

[Service] connects the SDK to a remote Integrity Service. It is unnecessary when a workflow only exports a local manifest.

Value

Each exported name is a list of class eqty_sdk_proxy that lazily resolves the corresponding Python SDK class, enum, or constant. Accessing a member with $ returns that member through reticulate. Constructors and factories return Python-backed objects inheriting from python.builtin.object, with SDK-specific classes such as Dataset, Context, or CID. These objects represent assets, provenance contexts, content identifiers, and the other SDK types described above. Enum members and constants represent the SDK's supported categories and algorithms.

Examples

# Inspect the lazy proxy without initializing Python.
class(Dataset)
stopifnot(inherits(Dataset, "eqty_sdk_proxy"))

Compute a CID for Bytes

Description

A CID is derived from content and changes when that content changes.

Usage

get_cid_for_bytes(...)

Arguments

Value

A [CID] for the supplied bytes.

Compute a CID for JSON

Description

Compute a CID for JSON

Usage

get_cid_for_json(...)

Arguments

Value

A [CID] for the supplied JSON value.

Compute a CID for a File or Directory

Description

Compute a CID for a File or Directory

Usage

get_cid_for_path(...)

Arguments

Value

A [CID] derived from the content at the supplied path.

Wrap an R Function as a Computation

Description

Creates a callable computation from an R function. When the returned function is called, the SDK records its inputs and outputs in the selected [Context]. The function executes directly in R. Its source is registered as a [Code] asset, and each call creates a [Computation] that connects that code and the call's inputs to its outputs. The computation can then serve as an entry point when the context is exported as a manifest.

Usage

integrity_compute(
  context = NULL,
  metadata = list(),
  func = NULL,
  `_store` = FALSE
)

Arguments

Value

An R function that calls ‘func' and records the computation’s inputs and outputs. Calling this function returns a Python-backed SDK asset inheriting from python.builtin.object, or an R list of such assets for multiple outputs. Each asset represents a result of 'func' and provides its content identifier through '$cid'. If 'func' is 'NULL', returns an R function that accepts the function to wrap; creating this intermediate function does not initialize Python.

Examples

# Create a decorator without requiring Python or the SDK.
sum_decorator <- integrity_compute(metadata = list(name = "Sum Generator"))
stopifnot(is.function(sum_decorator))

## Not run: 
# Requires Python >= 3.10 and the 'eqty-sdk' Python package.
# First use may download and install this additional software.
ctx <- Context$new("Example computation")
invisible(integrity_init(default_context = ctx, custom_dir = tempdir()))
signer <- Signer$load_or_create(name = "example-computation-signer")
invisible(integrity_set_active_signer(signer))

my_algo <- integrity_compute(
  context = ctx,
  metadata = list(name = "Sum Generator"),
  func = function(x, y) x + y
)

# The result is an SDK asset representing the sum.
result <- my_algo(10, 20)
result$cid

## End(Not run)

Create a Python Dictionary for SDK Calls

Description

Converts named R values to a Python 'dict' for SDK methods that expect one.

Usage

integrity_dict(...)

Arguments

Value

A Python 'dict' object.

Initialize the Eqty SDK

Description

Prepares the SDK's local state. Call this before changing configuration or creating lineage statements. Supply a default context when assets and computations should use it unless another context is selected explicitly.

Usage

integrity_init(...)

Arguments

Value

A Python-backed [Config] object for hashing, blob storage, directory filtering, and default-context settings.

Create a Python Path for SDK Calls

Description

Converts an R path value to Python's 'pathlib.Path', as required by methods such as 'Context$export()' and 'Context$import_manifest()'.

Usage

integrity_path(path)

Arguments

Value

A Python 'pathlib.Path' object.

Resolve a Path from an SDK Value

Description

Extracts a character path from an SDK asset, a Python path object, or a character value. If no direct path is available, the helper also checks the object's value.

Usage

integrity_resolve_path(input_object)

Arguments

Value

A character string containing the resolved path. Returns 'NULL' if no path could be determined.

Examples

integrity_resolve_path("data/input.csv")
integrity_resolve_path(list(path = "output/result.csv"))
stopifnot(identical(
  integrity_resolve_path("data/input.csv"), "data/input.csv"
))

Set the Active Signer

Description

Sets the signer used when higher-level SDK operations create signed statements. Configure it during workflow setup after [integrity_init()].

Usage

integrity_set_active_signer(signer)

Arguments

Value

'NULL'.

Clear the Local Blob Store

Description

Removes blobs cached in the SDK's local state. This is intended primarily for testing, development, or an intentional local reset.

Usage

purge_blob_store(...)

Arguments

Value

'NULL'.

Clear the Local Statement Store

Description

Removes locally recorded lineage statements. Normal application workflows generally preserve this state.

Usage

purge_statement_store(...)

Arguments

Value

'NULL'.

Verify a Lineage Statement

Description

Recomputes the statement identifier from its canonicalized JSON-LD content and checks it against the statement's recorded identifier. The check runs locally. Pass the manifest's context map when custom JSON-LD contexts are involved.

Usage

verify_statement(...)

Arguments

Value

'TRUE' when the statement identifier matches its content; otherwise 'FALSE'.

Verify a Verifiable Credential

Description

Checks a W3C Verifiable Credential proof locally. A statement identifier can also be supplied to confirm that the credential refers to the expected statement. Revocation and suspension status are outside this offline check.

Usage

verify_vc(...)

Arguments

Value

'TRUE' when the credential proof and optional subject binding verify; otherwise 'FALSE'.