size: Add Size metadata to an object

View source: R/size.R

sizeR Documentation

Add Size metadata to an object

Description

Add the optional DataCite Size property as an attribute to an R object.

Usage

size(x)

Arguments

x

An R object, such as a data.frame, a tibble, or a character vector.

Details

Size is an optional property in DataCite 4.3. The object size is estimated with [utils]{object.size}.

Value

The estimated object size in memory is added as an attribute to x in SI kB and IEC KiB (legacy Kb) units, rounded to two decimals. Returns the x object.

See Also

Other Reference metadata functions: creator(), dataset_source(), description(), geolocation(), identifier(), language, publication_year(), publisher(), rights(), version()

Examples

iris_dataset <- size(iris)
attr(iris_dataset, "Size")

dataset documentation built on March 31, 2023, 10:24 p.m.