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

R.utils (version 1.7.4)

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

171,037

Version

1.7.4

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

April 4th, 2011

Functions in R.utils (1.7.4)

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

Arguments

Static class to validate and process arguments

Settings

Class for applicational settings

GString

Character string with advanced substitutions

bunzip2

Bunzip a file

currentTimeMillis.System

Get the current time in milliseconds

as.logical.Verbose

Gets a logical value of this object

devEval

Opens a new device, evaluate (graphing) code, and closes device

System

Static class to query information about the system

Sys.setenv

ProgressBar

Provides text based counting progress bar

arrayIndex

Converts vector indices to array indices

as.list.Options

Gets a list representation of the options

as.character.Verbose

Returns a character string version of this object

Verbose

Class to writing verbose messages to a connection or file

as.character.Options

Returns a character string version of this object

capitalize

Capitalizes/decapitalizes each character string in a vector

devGetLabel

Gets the label of a device

capture.Verbose

Captures output of a function

countLines

Counts the number of lines in a text file

callHooks.function

Call hook functions

NullVerbose

A Verbose class ignoring everything

compile.SmartComments

Preprocess a vector of code lines

flush.TextStatusBar

Flushes the output

TextStatusBar

A status bar at the R prompt that can be updated

createLink

Creates a link to a file or a directory

getBuiltinRversion.GString

Gets the current R version

detachPackage

Detaches a packages by name

colClasses

Creates a vector of column classes used for tabular reading

as.character.GString

Gets the processed character string

SmartComments

Abstract class SmartComments

Assert

The Assert class

env

Creates a new environment, evaluates an expression therein, and returns the environment

findSettings.Settings

Searches for the settings file in one or several directories

attachLocally.list

Assigns an objects elements locally

convertComment.SmartComments

Converts a single smart comment to R code

devIsOpen

Checks if a device is open or not

getReadablePathname.Arguments

Gets a readable pathname

commandArgs

Extract Command Line Arguments

asShort.Java

Converts a numeric to a Java short

evaluate.Verbose

Evaluates a function and prints its results if above threshold

doCall

Executes a function call with option to ignore unused arguments

Java

Static class for Java related methods

mkdirs

Creates a directory including any necessary but nonexistent parent directories

asInt.Java

Converts an numeric to a Java integer

LComments

The LComments class

getNumerics.Arguments

Coerces to a numeric vector and validates

VComments

The VComments class

as.character.ProgressBar

Gets a string description of the progress bar

Non-documented objects

findGraphicsDevice.System

Searches for a working PNG device

R.utils-package

Package R.utils

devSetLabel

Sets the label of a device

getDoubles.Arguments

Coerces to a double vector and validates

getAbsolutePath

Gets the absolute pathname string

getMessage.TimeoutException

Gets the message of the exception

getBarString.ProgressBar

Gets the progress bar string to be displayed

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

devOff

Closes a device

dataFrame

Allocates a data frame with given column classes

getBuiltinDatetime.GString

Gets the current date and time

getHostname.System

Retrieves the computer name of the current host

isOn.Verbose

Checks if the output is on

isVector.Assert

Static method asserting thatan object is a vector

check.Assert

Static method asserting that a generic condition is true

devDone

Closes an open device unless it is a on-screen (interactive) device

getBuiltinHostname.GString

Gets the hostname of the system running R

eps

EPS graphics device

downloadFile.character

Downloads a file

dimNA< -

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

getIndices.Arguments

Coerces to a integer vector and validates

equals.Verbose

Checks if this object is equal to another

asByte.Java

Converts a numeric to a Java byte

getUsername.System

Retrieves the name of the user running R

getEnvironment.Arguments

Gets an existing environment

enter.Verbose

Writes a message and indents the following output

getTimestampFormat.Verbose

Gets the default timestamp format

isMatrix.Assert

Static method asserting thatan object is a matrix

getLeaves.Options

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

createFileAtomically

Creates a file atomically

getBuiltinDate.GString

Gets the current date

exit.Verbose

Writes a message and unindents the following output

asLong.Java

Converts a numeric to a Java long

findGhostscript.System

Searches for the ghostview binary on the current system

isPackageInstalled

Checks if a package is installed or not

getBuiltinTime.GString

Gets the current time

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

callHooks

Call hook functions by hook name

Pushes the current indentation state of the Verbose object

MultiVerbose

A Verbose class ignoring everything

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

getOption.Options

Gets an option

getCharacters.Arguments

Coerces to a character vector and validates

jpeg2

A JPEG device for Bitmap Files via GhostScript

moveInSearchPath

Moves a environment in the search path to another position

FileProgressBar

A progress bar that sets the size of a file accordingly

getRaw.GString

Gets the unprocessed GString

inAnyInterval.numeric

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

Gets a numeric value of this object

print.GString

Prints the processed GString

readShort.Java

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

popTemporaryFile

Drops a temporary suffix from the temporary pathname

getVector.Arguments

Validates a vector

equals.Options

Checks if this object is equal to another Options object

getWritablePathname.Arguments

Gets a writable pathname

getBuiltinOs.GString

Gets the operating system of the running machine

Reads a file in table format

update.ProgressBar

Updates progress bar

convertComment.VComments

Converts a verbose comment to R code

copyDirectory

Copies a directory

cat.Verbose

Concatenates and prints objects if above threshold

TimeoutException

TimeoutException represents timeout errors

displayCode

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

getBuiltinUsername.GString

Gets the username of the user running R

getRegularExpression.Arguments

Gets a valid regular expression pattern

isUrl

Checks if one or several pathnames is URLs

extract.array

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

popMessage.TextStatusBar

Adds a message above the status bar

getThreshold.Verbose

Gets current verbose threshold

getInstanceOf.Arguments

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

devList

Lists the indices of the open devices named by their labels

parse.GString

Parses a GString

finalizeSession

Function to call for finalizing the R session

getRelativePath

Gets the relative pathname relative to a directory

evalWithTimeout

Evaluate an R expression and interrupts it if it takes too long

loadToEnv

Method to load objects to a new environment

inherits.Assert

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

filePath

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

printf.Verbose

Formats and prints object if above threshold

getVerbose.Arguments

Coerces to Verbose object

getParent

Gets the string of the parent specified by this pathname

parse.SmartComments

Parses one single smart comment

isModified.Settings

Checks if settings has been modified compared to whats on file

toCamelCase

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

isPackageLoaded

Checks if a package is loaded or not

readBinFragments

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

readRdHelp

Reads one or more Rd help files in a certain format

isEof.connection

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

readInt.Java

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

promptAndSave.Settings

Prompt user to save modified settings

getVariableValue.GString

Gets a variable value given a name and attributes

fileAccess

Checks the permission of a file or a directory

hpaste

Concatenating vectors into human-readable strings

increase.ProgressBar

Increases (steps) progress bar

setTicks.ProgressBar

Sets values for which ticks should be visible

intToBin

Converts an integer to a binary/octal/hexadecimal number

isScalar.Assert

Static method asserting thatan object is a single value

getLogicals.Arguments

Coerces to a logical vector and validates

mapToIntervals.numeric

Maps values to intervals

removeDirectory

Removes a directory

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

lapply.MultiVerbose

Applies a function to each of the Verbose objects

loadAnywhere.Settings

Loads settings from file

onSessionExit

Registers a function to be called when the R session finishes

isOpen.character

Checks if there is an open connection to a file

readTableIndex

Reads a single column from file in table format

png2

A PNG device for Bitmap Files via GhostScript

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

listDirectory

Gets the file names in the directory

nbrOfOptions.Options

Gets the number of options set

devSet

Activates a device

isDone.ProgressBar

Checks if progress bar is completed

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

header.Verbose

Writes a header

setStepLength.ProgressBar

Sets default step length

isDirectory

Checks if the file specification is a directory

str.Options

Prints the structure of the options

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

loadObject

Method to load object from a file or a connection

less.Verbose

Creates a cloned instance with a higher threshold

pushBackupFile

Appends a backup suffix to the pathname

unwrap.array

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

isOn.NullVerbose

Checks if the output is on

setLabels.TextStatusBar

Sets new values of given labels

getLabel.TextStatusBar

Gets the current value of a label

subplots

Creates a grid of subplots

newline.Verbose

Writes one or several empty lines

seqToHumanReadable

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

splitByPattern

Splits a single character string by pattern

isAbsolutePath

Checks if this pathname is absolute

printf

C-style formatted output

setProgress.ProgressBar

Sets current progress

readByte.Java

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

patchCode

Patches installed and loaded packages and more

resample

Sample values from a set of elements

reset.VComments

Resets a VComments compiler

seqToIntervals

Gets all contigous intervals of a vector of indices

findSourceTraceback

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

validate.SmartComments

Validates the compiled lines

popBackupFile

Drops a backup suffix from the backup pathname

lastModified

Gets the time when the file was last modified

timestamp.Verbose

Writes a timestamp

more.Verbose

Creates a cloned instance with a lower threshold

onGarbageCollect

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

names.Options

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

print.Verbose

Prints objects if above threshold

getBuiltinRhome.GString

Gets the path where R is installed

getBuiltinPid.GString

Gets the process id of the current R session

getIntegers.Arguments

Coerces to a integer vector and validates

setDefaultLevel.Verbose

Sets the current default verbose level

writeRaw.Verbose

Writes objects if above threshold

getReadablePathnames.Arguments

Gets a readable pathname

saveObject

Saves an object to a file or a connection

hasOption.Options

Checks if an option exists

setValue.ProgressBar

Sets current value

setLabel.TextStatusBar

Sets the value of a label

writeByte.Java

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

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

newline.TextStatusBar

Writes a newline

isVisible.Verbose

Checks if a certain verbose level will be shown or not

reassignInPackage

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

setMaxValue.ProgressBar

Sets maximum value

summary.Verbose

Generates a summary of an object if above threshold

reset.SmartComments

Resets a SmartComments compiler

mergeIntervals.numeric

Merges intervals

isFile

Checks if the file specification is a file

resetWarnings

Resets recorded warnings

pushTemporaryFile

Appends a temporary suffix to the pathname

writeInt.Java

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

setOption

Sets a option in R

isZero

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

insert

Insert values to a vector at certain positions

sourceTo

Parses and evaluates code from a file or a connection

str.Verbose

Prints the structure of an object if above threshold

readUTF.Java

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

writeShort.Java

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

stext

Writes text in the margin along the sides of a plot

update.FileProgressBar

Updates file progress bar

relibrary

Reloads a package

update.TextStatusBar

Updates the status bar (visually)

renameFile

Renames a file safely

setThreshold.Verbose

Sets verbose threshold

remove.FileProgressBar

Removes the progress file for a file progress bar

openBrowser.System

Opens an HTML document using the OS default HTML browser

writeUTF.Java

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

timestampOn.Verbose

Turns automatic timestamping on and off

writeBinFragments

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

whichVector.logical

Identifies TRUE elements in a logical vector

warnings.Verbose

Outputs any warnings recorded

toUrl

Converts a pathname into a URL

reset.ProgressBar

Reset progress bar

writeRaw.MultiVerbose

Writes to each of the Verbose objects

writeRaw.NullVerbose

All output methods

saveAnywhere.Settings

Saves settings to file

touchFile

Updates the timestamp of a file

setTimestampFormat.Verbose

Sets the default timestamp format

wrap.array

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

sourceDirectory

Sources files recursively to either local or global environment

validate.VComments

Validates the compiled lines

updateLabels.TextStatusBar

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