str.am_doc: Display the structure of an Automerge document

In automerge: R Bindings for 'Automerge' 'CRDT' Library

Display the structure of an Automerge document

Description

S3 method for utils::str() that displays the structure of an Automerge document in a human-readable format.

Usage

## S3 method for class 'am_doc'
str(object, max.level = 2, ...)

Arguments

object	An automerge document object.
max.level	Maximum depth to recurse into nested structures. Default 2.
...	Additional arguments (ignored).

Value

Invisibly returns NULL.

Examples

doc <- am_create()
doc$name <- "Alice"
doc$data <- list(x = 1L, y = 2L)
str(doc)
str(doc, max.level = 1)
am_close(doc)

automerge documentation built on Feb. 5, 2026, 5:08 p.m.