Converters {memuse}R Documentation

Converters

Description

Converter methods.

Usage

as.memuse(x, ...)

## S4 method for signature 'numeric'
as.memuse(x, unit = .UNIT, unit.prefix = .PREFIX,
  unit.names = .NAMES)

## S4 method for signature 'object_size'
as.memuse(x, unit = .UNIT, unit.prefix = .PREFIX,
  unit.names = .NAMES)

## S4 method for signature 'character'
as.memuse(x, unit = .UNIT, unit.prefix = .PREFIX,
  unit.names = .NAMES)

## S4 method for signature 'memuse'
as.character(x, ...)

## S4 method for signature 'memuse'
as.numeric(x, as.is = FALSE)

Arguments

x

Numeric value, object_size data, or appropriate string (see details section for more information).

...

Additional arguments.

unit

string; the unit of storage, such as "MiB" or "MB", depending on prefix. Case is ignored.

unit.prefix

string; the unit prefix, namely IEC or SI. Case is ignored.

unit.names

string; control for whether the unit names should be printed out or their abbreviation should be used. Options are "long" and "short", respectively. Case is ignored.

as.is

logical; should the size be "as-is", or converted to bytes first.

Details

These methods convert numeric, object_size, and string (character) objects into memuse objects.

Strings must be of the same form as the printed output of a a memuse object. For example, "100 KiB" is valid, but "100 (KiB)" is not. As always, case of the unit is ignored, and so "100 kib" would be valid as well.

Value

Returns a memuse object.

See Also

memuse-class Accessors

Examples

## Not run: 
as.memuse(10)

## End(Not run)
[Package memuse version 3.0-1 Index]