⚠️There's a newer version (2.13.0) of this package.Take me there.

R.utils (version 1.5.8)

Various programming utilities

Description

This package provides utility classes and methods useful when programming in R and developing R packages.

Copy Link

Version

Install

install.packages('R.utils')

Monthly Downloads

163,892

Version

1.5.8

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

November 24th, 2010

Functions in R.utils (1.5.8)

Settings

Class for applicational settings

System

Static class to query information about the system

MultiVerbose

A Verbose class ignoring everything

currentTimeMillis.System

Get the current time in milliseconds

asByte.Java

Converts a numeric to a Java byte

LComments

The LComments class

callHooks

Call hook functions by hook name

detachPackage

Detaches a packages by name

GString

Character string with advanced substitutions

as.character.GString

Gets the processed character string

SmartComments

Abstract class SmartComments

as.list.Options

Gets a list representation of the options

Java

Static class for Java related methods

colClasses

Creates a vector of column classes used for tabular reading

getVerbose.Arguments

Coerces to Verbose object

TextStatusBar

A status bar at the R prompt that can be updated

devGetLabel

Gets the label of a device

gzip

Gzip/Gunzip a file

findSettings.Settings

Searches for the settings file in one or several directories

as.character.Options

Returns a character string version of this object

as.character.Verbose

Returns a character string version of this object

getReadablePathnames.Arguments

Gets a readable pathname

hasOption.Options

Checks if an option exists

filePath

Construct the path to a file from components and expands Windows Shortcuts along the pathname from root to leaf

asInt.Java

Converts an numeric to a Java integer

Assert

The Assert class

exit.Verbose

Writes a message and unindents the following output

bunzip2

Bunzip a file

getBuiltinDate.GString

Gets the current date

asShort.Java

Converts a numeric to a Java short

arrayIndex

Converts vector indices to array indices

getIndices.Arguments

Coerces to a integer vector and validates

downloadFile.character

Downloads a file

commandArgs

Extract Command Line Arguments

ProgressBar

Provides text based counting progress bar

Sets the label of a device

convertComment.SmartComments

Converts a single smart comment to R code

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

setValue.ProgressBar

Sets current value

countLines

Counts the number of lines in a text file

Non-documented objects

ruler.Verbose

Writes a ruler

getAbsolutePath

Gets the absolute pathname string

finalizeSession

Function to call for finalizing the R session

compile.SmartComments

Preprocess a vector of code lines

as.double.Verbose

Gets a numeric value of this object

capitalize

Capitalizes/decapitalizes each character string in a vector

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

inAnyInterval.numeric

Checks if a set of values are inside one or more intervals

capture.Verbose

Captures output of a function

getRaw.GString

Gets the unprocessed GString

getReadablePathname.Arguments

Gets a readable pathname

timestamp.Verbose

Writes a timestamp

isEof.connection

Checks if the current file position for a connection is at the 'End of File'

getHostname.System

Retrieves the computer name of the current host

createLink

Creates a link to a file or a directory

getBuiltinOs.GString

Gets the operating system of the running machine

convertComment.VComments

Converts a verbose comment to R code

getLabel.TextStatusBar

Gets the current value of a label

getBuiltinUsername.GString

Gets the username of the user running R

Verbose

Class to writing verbose messages to a connection or file

getRegularExpression.Arguments

Gets a valid regular expression pattern

getBuiltinHostname.GString

Gets the hostname of the system running R

as.character.ProgressBar

Gets a string description of the progress bar

copyDirectory

Copies a directory

names.Options

Gets the full pathname of all (non-list) options

newline.Verbose

Writes one or several empty lines

equals.Options

Checks if this object is equal to another Options object

equals.Verbose

Checks if this object is equal to another

getBuiltinRversion.GString

Gets the current R version

readBinFragments

Reads binary data from disjoint sections of a connection or a file

findGhostscript.System

Searches for the ghostview binary on the current system

getInstanceOf.Arguments

Gets an instance of the object that is of a particular class

Parses and evaluates code from a file or a connection

isOpen.character

Checks if there is an open connection to a file

readShort.Java

Reads a Java formatted short (16 bits) from a connection

png2

A PNG device for Bitmap Files via GhostScript

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

flush.TextStatusBar

Flushes the output

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

printf

C-style formatted output

warnings.Verbose

Outputs any warnings recorded

isOn.NullVerbose

Checks if the output is on

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

getVector.Arguments

Validates a vector

isAbsolutePath

Checks if this pathname is absolute

loadToEnv

Method to load objects to a new environment

getBarString.ProgressBar

Gets the progress bar string to be displayed

off.Verbose

Turn off the output

setProgress.ProgressBar

Sets current progress

intToBin

Converts an integer to a binary/octal/hexadecimal number

getBuiltinPid.GString

Gets the process id of the current R session

writeRaw.Verbose

Writes objects if above threshold

getLogicals.Arguments

Coerces to a logical vector and validates

unwrap.array

Unwrap an array, matrix or a vector to an array of more dimensions

getWritablePathname.Arguments

Gets a writable pathname

getDoubles.Arguments

Coerces to a double vector and validates

splitByPattern

Splits a single character string by pattern

mapToIntervals.numeric

Maps values to intervals

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

insert

Insert values to a vector at certain positions

summary.Verbose

Generates a summary of an object if above threshold

str.Verbose

Prints the structure of an object if above threshold

isFile

Checks if the file specification is a file

more.Verbose

Creates a cloned instance with a lower threshold

Options

The Options class

print.Verbose

Prints objects if above threshold

setTicks.ProgressBar

Sets values for which ticks should be visible

getOption.Options

Gets an option

less.Verbose

Creates a cloned instance with a higher threshold

writeRaw.MultiVerbose

Writes to each of the Verbose objects

getVariableValue.GString

Gets a variable value given a name and attributes

readByte.Java

Reads a Java formatted byte (8 bits) from a connection

removeDirectory

Removes a directory

seqToHumanReadable

Gets a short human readable string representation of an vector of indices

VComments

The VComments class

wrap.array

Reshape an array or a matrix by permuting and/or joining dimensions

findSourceTraceback

Finds all 'srcfile' objects generated by source() in all call frames

setDefaultLevel.Verbose

Sets the current default verbose level

getNumerics.Arguments

Coerces to a numeric vector and validates

displayCode

Displays the contents of a text file with line numbers and more

callHooks.function

Call hook functions

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

sourceDirectory

Sources files recursively to either local or global environment

attachLocally.list

Assigns an objects elements locally

getBuiltinDatetime.GString

Gets the current date and time

isDone.ProgressBar

Checks if progress bar is completed

listDirectory

Gets the file names in the directory

check.Assert

Static method asserting that a generic condition is true

isScalar.Assert

Static method asserting thatan object is a single value

saveAnywhere.Settings

Saves settings to file

jpeg2

A JPEG device for Bitmap Files via GhostScript

update.FileProgressBar

Updates file progress bar

isDirectory

Checks if the file specification is a directory

moveInSearchPath

Moves a environment in the search path to another position

validate.VComments

Validates the compiled lines

readUTF.Java

Reads a Java (UTF-8) formatted string from a connection

devIsOpen

Checks if a device is open or not

whichVector.logical

Identifies TRUE elements in a logical vector

isZero

Checks if a value is (close to) zero or not

mkdirs

Creates a directory including any necessary but nonexistent parent directories

newline.TextStatusBar

Gets the number of options set

validate.SmartComments

Validates the compiled lines

str.Options

Prints the structure of the options

updateLabels.TextStatusBar

Sets the new values of given labels and updates the status bar

setThreshold.Verbose

Sets verbose threshold

subplots

Creates a grid of subplots

readRdHelp

Reads one or more Rd help files in a certain format

writeInt.Java

Writes a integer (32 bits) to a connection in Java format

evaluate.Verbose

Evaluates a function and prints its results if above threshold

copyFile

Copies a file safely

writeByte.Java

Writes a byte (8 bits) to a connection in Java format

setStepLength.ProgressBar

Sets default step length

writeUTF.Java

Writes a string to a connection in Java format (UTF-8)

seqToIntervals

Gets all contigous intervals of a vector of indices

openBrowser.System

Opens an HTML document using the OS default HTML browser

writeBinFragments

Writes binary data to disjoint sections of a connection or a file

eps

EPS graphics device

lapply.MultiVerbose

Applies a function to each of the Verbose objects

getIntegers.Arguments

Coerces to a integer vector and validates

fileAccess

Checks the permission of a file or a directory

on.Verbose

Turn on the output

onGarbageCollect

Registers a function to be called when the R garbage collector is (detected to be) running

reset.SmartComments

Resets a SmartComments compiler

popMessage.TextStatusBar

Adds a message above the status bar

dimNA< -

Sets the dimension of an object with the option to infer one dimension autmatically

getTimestampFormat.Verbose

Gets the default timestamp format

patchCode

Patches installed and loaded packages and more

timestampOn.Verbose

Turns automatic timestamping on and off

parse.GString

Parses a GString

printf.Verbose

Formats and prints object if above threshold

resample

Sample values from a set of elements

resetWarnings

Resets recorded warnings

setLabel.TextStatusBar

Sets the value of a label

readInt.Java

Reads a Java formatted int (32 bits) from a connection

setLabels.TextStatusBar

Sets new values of given labels

setTimestampFormat.Verbose

Sets the default timestamp format

NullVerbose

A Verbose class ignoring everything

reassignInPackage

Re-assigns a new value to an existing object in a loaded package

stext

Writes text in the margin along the sides of a plot

update.TextStatusBar

Updates the status bar (visually)

isOn.Verbose

Checks if the output is on

Concatenates and prints objects if above threshold

getBuiltinTime.GString

Gets the current time

devList

Lists the indices of the open devices named by their labels

toCamelCase

Converts a string of words into a merged camel-cased word

getThreshold.Verbose

Gets current verbose threshold

extract.array

Extract a subset of an array, matrix or a vector with unknown dimensions

loadObject

Method to load object from a file or a connection

isVisible.Verbose

Checks if a certain verbose level will be shown or not

getCharacters.Arguments

Coerces to a character vector and validates

getRelativePath

Gets the relative pathname relative to a directory

loadAnywhere.Settings

Loads settings from file

increase.ProgressBar

Increases (steps) progress bar

isPackageInstalled

Checks if a package is installed or not

promptAndSave.Settings

Prompt user to save modified settings

writeShort.Java

Writes a short (16 bits) to a connection in Java format

onSessionExit

Registers a function to be called when the R session finishes

toUrl

Converts a pathname into a URL

readTableIndex

Reads a single column from file in table format

lastModified

Gets the time when the file was last modified

remove.FileProgressBar

Removes the progress file for a file progress bar

reset.VComments

Resets a VComments compiler

pushState.Verbose

Pushes the current indentation state of the Verbose object

getBuiltinRhome.GString

Gets the path where R is installed

FileProgressBar

A progress bar that sets the size of a file accordingly

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

devDone

Closes an on-screen (interactive) device

dataFrame

Allocates a data frame with given column classes

getUsername.System

Retrieves the name of the user running R

isMatrix.Assert

Static method asserting thatan object is a matrix

isModified.Settings

Checks if settings has been modified compared to whats on file

mergeIntervals.numeric

Merges intervals

touchFile

Updates the timestamp of a file

readTable

Reads a file in table format

getLeaves.Options

Gets all (non-list) options in a flat list

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

asLong.Java

Converts a numeric to a Java long

enter.Verbose

Writes a message and indents the following output

doCall

Executes a function call with option to ignore unused arguments

isUrl

Checks if one or several pathnames is URLs

findGraphicsDevice.System

Searches for a working PNG device

parse.SmartComments

Parses one single smart comment

print.GString

Prints the processed GString

saveObject

Saves an object to a file or a connection

isVector.Assert

Static method asserting thatan object is a vector

Arguments

Static class to validate and process arguments

as.logical.Verbose

Gets a logical value of this object

getEnvironment.Arguments

Gets an existing environment

getParent

Gets the string of the parent specified by this pathname

inherits.Assert

Static method asserting that an object inherits from of a certain class

header.Verbose

Writes a header

isPackageLoaded

Checks if a package is loaded or not

setMaxValue.ProgressBar

Sets maximum value