Package 'dgread'

Title: Read Dynamic Group (dg/dgz) Data Files
Description: Fast reader for dg (dynamic group) and dgz (compressed) data files. These files store collections of named arrays with support for nested and ragged (variable-length) data, commonly used in neuroscience and behavioral research.
Authors: David Sheinberg [aut, cre]
Maintainer: David Sheinberg <[email protected]>
License: MIT + file LICENSE
Version: 1.1.0
Built: 2026-05-31 22:58:12 UTC
Source: https://github.com/SheinbergLab/dgread

Help Index


Fetch a dynamic group from a running dlsh/Tcl interpreter

Description

Retrieves a dynamic group by name from an embedded dlsh Tcl interpreter (via the tcltk bridge) and returns it as a named list.

Usage

dg.get(groupname, convert.underscore = FALSE)

Arguments

groupname

Name of the dynamic group in the Tcl interpreter.

convert.underscore

If TRUE, replace _ with . in element names.

Value

A named list of the group's columns, or NULL if the group does not exist.


Read a dg/dgz data file

Description

Reads a dynamic-group data file – plain .dg, gzip-compressed .dgz, or LZ4 .lz4 – into a named list. Each element is a column; nested / ragged columns are returned as lists.

Usage

read.dgz(file, convert.underscore = FALSE)

read.dg(file, convert.underscore = FALSE)

Arguments

file

Path to the .dg/.dgz/.lz4 file.

convert.underscore

If TRUE, replace _ with . in element names.

Value

A named list of the group's columns.

Examples

d <- read.dgz(system.file("extdata", "sample.dgz", package = "dgread"))
names(d)