mvl_object_stats: Return MVL object properties

View source: R/RMVL.R

mvl_object_statsR Documentation

Return MVL object properties

Description

Provide detailed information on stored MVL object without retrieving it

Usage

mvl_object_stats(MVLHANDLE, offset = NULL, scan = FALSE)

Arguments

MVLHANDLE

either a handle provided by mvl_open() or an MVL object such as produced by indexing operators

offset

offset to the object which properties are to be retrieved

scan

scan vector element to obtain additional statistics

Details

This function is given either an MVL handle and an offset in MVL file to examine, or just a single parameter of class MVL_OBJECT that contains both handle and offset

This function returns a list of object parameters describing total number of elements, element type (as used by libMVL) and a pointer to the underlying data. The pointer is passed via a cast to double to preserve its 64-bit value and can be used with custom C code, for example by using package inline.

Value

list with object properties


RMVL documentation built on Nov. 2, 2023, 6:09 p.m.

Related to mvl_object_stats in RMVL...