Last data update: 2014.03.03

R: Control Variables for the memuse Package.
Control VariablesR Documentation

Control Variables for the memuse Package.

Description

A set of controls which provides (changeable) default values for many functions in this package.

Usage

.UNIT

.NAMES

.PREFIX

.PRECEDENCE

Format

 chr "best"

Details

Currently, there are 4 control data objects:

  • .UNIT defaults to "best". The default choice will scale size values to the nearest (by scaling factor — 1024 or 1000 depending on unit prefix). Other acceptable choices are, for example, "kb" or "kib". If the user requests the wrong unit by prefix (e.g., "kb" instead of "kib" when the unit prefix is IEC), then the correct one will be chosen for the user.

  • .PREFIX defaults to "IEC". Acceptable values are "IEC" and "SI".

  • .NAMES defaults to "short". Acceptable values are "short" and "long".

  • .PRECEDENCE defaults to "prefix". Acceptable values are "unit" and "prefix".

All values are case insensitive, in that the correct case will be determined for the user if the incorrect case is supplied. For example, if the user sets .PREFIX <- "si", then the correct case ("SI") will be determined as needed.

For a "human readable" explanation of what these values do, see the package vignette.

See Also

memuse-class Constructor

Examples

## Not run: 
mu(2000)
.PREFIX <- "SI"
mu(2000)

## End(Not run)

Results