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

R.utils (version 1.7.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

226,490

Version

1.7.8

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

July 25th, 2011

Functions in R.utils (1.7.8)

GString

Character string with advanced substitutions

commandArgs

Extract Command Line Arguments

as.character.Options

Returns a character string version of this object

MultiVerbose

A Verbose class ignoring everything

FileProgressBar

A progress bar that sets the size of a file accordingly

arrayIndex

Converts vector indices to array indices

callHooks

Call hook functions by hook name

findGhostscript.System

Searches for the ghostview binary on the current system

Settings

Class for applicational settings

Java

Static class for Java related methods

as.character.ProgressBar

Gets a string description of the progress bar

currentTimeMillis.System

Get the current time in milliseconds

devOff

Closes a device

capture.Verbose

Captures output of a function

fileAccess

Checks the permission of a file or a directory

Options

The Options class

displayCode

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

asLong.Java

Converts a numeric to a Java long

as.character.GString

Gets the processed character string

TextStatusBar

A status bar at the R prompt that can be updated

Checks if the file specification is a directory

createFileAtomically

Creates a file atomically

ProgressBar

Provides text based counting progress bar

SmartComments

Abstract class SmartComments

devList

Lists the indices of the open devices named by their labels

devIsOpen

Checks if a device is open or not

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

extract.array

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

NullVerbose

A Verbose class ignoring everything

getInstanceOf.Arguments

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

LComments

The LComments class

createLink

Creates a link to a file or a directory

getNumerics.Arguments

Coerces to a numeric vector and validates

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

devDone

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

enter.Verbose

Writes a message and indents the following output

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

env

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

as.double.Verbose

Gets a numeric value of this object

Non-documented objects

finalizeSession

Function to call for finalizing the R session

cat.Verbose

Concatenates and prints objects if above threshold

getBuiltinTime.GString

Gets the current time

convertComment.SmartComments

Converts a single smart comment to R code

TimeoutException

TimeoutException represents timeout errors

VComments

The VComments class

as.character.Verbose

Returns a character string version of this object

capitalize

Capitalizes/decapitalizes each character string in a vector

convertComment.VComments

Converts a verbose comment to R code

getIndices.Arguments

Coerces to a integer vector and validates

System

Static class to query information about the system

Assert

The Assert class

Sys.setenv

inAnyInterval.numeric

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

findSourceTraceback

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

readByte.Java

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

Arguments

Static class to validate and process arguments

nbrOfOptions.Options

Gets the number of options set

as.logical.Verbose

Gets a logical value of this object

findGraphicsDevice.System

Searches for a working PNG device

colClasses

Creates a vector of column classes used for tabular reading

detachPackage

Detaches a packages by name

increase.ProgressBar

Increases (steps) progress bar

equals.Options

Checks if this object is equal to another Options object

asInt.Java

Converts an numeric to a Java integer

exit.Verbose

Writes a message and unindents the following output

mkdirs

Creates a directory including any necessary but nonexistent parent directories

devSetLabel

Sets the label of a device

copyFile

Copies a file safely

attachLocally.list

Assigns an objects elements locally

devNew

Opens a new device

compile.SmartComments

Preprocess a vector of code lines

dimNA< -

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

getLabel.TextStatusBar

Gets the current value of a label

getVerbose.Arguments

Coerces to Verbose object

printf.Verbose

Formats and prints object if above threshold

findSettings.Settings

Searches for the settings file in one or several directories

Converts a numeric to a Java short

downloadFile.character

Downloads a file

getBuiltinRversion.GString

Gets the current R version

insert

Insert values to a vector at certain positions

Pushes the current indentation state of the Verbose object

getDoubles.Arguments

Coerces to a double vector and validates

lapply.MultiVerbose

Applies a function to each of the Verbose objects

loadToEnv

Method to load objects to a new environment

as.list.Options

Gets a list representation of the options

hpaste

Concatenating vectors into human-readable strings

getVector.Arguments

Validates a vector

asByte.Java

Converts a numeric to a Java byte

Verbose

Class to writing verbose messages to a connection or file

getAbsolutePath

Gets the absolute pathname string

countLines

Counts the number of lines in a text file

isSingle

Identifies all entries that exists exactly ones

getRegularExpression.Arguments

Gets a valid regular expression pattern

devGetLabel

Gets the label of a device

getBuiltinPid.GString

Gets the process id of the current R session

getWritablePathname.Arguments

Gets a writable pathname

getReadablePathnames.Arguments

Gets a readable pathname

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

dataFrame

Allocates a data frame with given column classes

getThreshold.Verbose

Gets current verbose threshold

isVector.Assert

Static method asserting thatan object is a vector

getBuiltinUsername.GString

Gets the username of the user running R

check.Assert

Static method asserting that a generic condition is true

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

getBuiltinDatetime.GString

Gets the current date and time

getBuiltinHostname.GString

Gets the hostname of the system running R

less.Verbose

Creates a cloned instance with a higher threshold

isZero

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

pushTemporaryFile

Appends a temporary suffix to the pathname

hasOption.Options

Checks if an option exists

isFile

Checks if the file specification is a file

isModified.Settings

Checks if settings has been modified compared to whats on file

getHostname.System

Retrieves the computer name of the current host

isOn.Verbose

Checks if the output is on

summary.Verbose

Generates a summary of an object if above threshold

getMessage.TimeoutException

Gets the message of the exception

getIntegers.Arguments

Coerces to a integer vector and validates

setMaxValue.ProgressBar

Sets maximum value

sourceTo

Parses and evaluates code from a file or a connection

evalWithTimeout

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

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

getBuiltinDate.GString

Gets the current date

setOption

Sets a option in R

getRelativePath

Gets the relative pathname relative to a directory

isPackageLoaded

Checks if a package is loaded or not

getOption.Options

Gets an option

toUrl

Converts a pathname into a URL

getReadablePathname.Arguments

Gets a readable pathname

newline.TextStatusBar

Writes a newline

writeBinFragments

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

readTable

Reads a file in table format

isEof.connection

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

popBackupFile

Drops a backup suffix from the backup pathname

isScalar.Assert

Static method asserting thatan object is a single value

doCall

Executes a function call with option to ignore unused arguments

popTemporaryFile

Drops a temporary suffix from the temporary pathname

getRaw.GString

Gets the unprocessed GString

printf

C-style formatted output

loadObject

Method to load object from a file or a connection

on.Verbose

Turn on the output

wrap.array

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

getBuiltinOs.GString

Gets the operating system of the running machine

parse.SmartComments

Parses one single smart comment

getParent

Gets the string of the parent specified by this pathname

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

lastModified

Gets the time when the file was last modified

getEnvironment.Arguments

Gets an existing environment

popMessage.TextStatusBar

Adds a message above the status bar

print.Verbose

Prints objects if above threshold

promptAndSave.Settings

Prompt user to save modified settings

reassignInPackage

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

getVariableValue.GString

Gets a variable value given a name and attributes

getLeaves.Options

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

getLogicals.Arguments

Coerces to a logical vector and validates

getBarString.ProgressBar

Gets the progress bar string to be displayed

getBuiltinRhome.GString

Gets the path where R is installed

mapToIntervals.numeric

Maps values to intervals

print.GString

Prints the processed GString

getCharacters.Arguments

Coerces to a character vector and validates

onSessionExit

Registers a function to be called when the R session finishes

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

readTableIndex

Reads a single column from file in table format

isAbsolutePath

Checks if this pathname is absolute

evaluate.Verbose

Evaluates a function and prints its results if above threshold

writeRaw.MultiVerbose

Writes to each of the Verbose objects

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

stext

Writes text in the margin along the sides of a plot

readBinFragments

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

more.Verbose

Creates a cloned instance with a lower threshold

isOn.NullVerbose

Checks if the output is on

saveObject

Saves an object to a file or a connection

listDirectory

Gets the file names in the directory

copyDirectory

Copies a directory

isReplicated

Identifies all entries with replicated values

setValue.ProgressBar

Sets current value

onGarbageCollect

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

openBrowser.System

Opens an HTML document using the OS default HTML browser

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

png2

A PNG device for Bitmap Files via GhostScript

isVisible.Verbose

Checks if a certain verbose level will be shown or not

header.Verbose

Writes a header

isPackageInstalled

Checks if a package is installed or not

timestamp.Verbose

Writes a timestamp

pushBackupFile

Appends a backup suffix to the pathname

mergeIntervals.numeric

Merges intervals

saveAnywhere.Settings

Saves settings to file

names.Options

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

renameFile

Renames a file safely

validate.SmartComments

Validates the compiled lines

setLabels.TextStatusBar

Sets new values of given labels

setProgress.ProgressBar

Sets current progress

isDone.ProgressBar

Checks if progress bar is completed

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

getUsername.System

Retrieves the name of the user running R

isOpen.character

Checks if there is an open connection to a file

isUrl

Checks if one or several pathnames is URLs

loadAnywhere.Settings

Loads settings from file

remove.FileProgressBar

Removes the progress file for a file progress bar

setTicks.ProgressBar

Sets values for which ticks should be visible

isMatrix.Assert

Static method asserting thatan object is a matrix

setTimestampFormat.Verbose

Sets the default timestamp format

jpeg2

A JPEG device for Bitmap Files via GhostScript

toCamelCase

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

unwrap.array

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

splitByPattern

Splits a single character string by pattern

update.TextStatusBar

Updates the status bar (visually)

subplots

Creates a grid of subplots

moveInSearchPath

Moves a environment in the search path to another position

str.Options

Prints the structure of the options

warnings.Verbose

Outputs any warnings recorded

equals.Verbose

Checks if this object is equal to another

off.Verbose

Turn off the output

validate.VComments

Validates the compiled lines

newline.Verbose

Writes one or several empty lines

Writes objects if above threshold

resample

Sample values from a set of elements

updateLabels.TextStatusBar

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

seqToHumanReadable

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

str.Verbose

Prints the structure of an object if above threshold

touchFile

Updates the timestamp of a file

setDefaultLevel.Verbose

Sets the current default verbose level

writeShort.Java

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

reset.SmartComments

Resets a SmartComments compiler

setLabel.TextStatusBar

Sets the value of a label

resetWarnings

Resets recorded warnings

sourceDirectory

Sources files recursively to either local or global environment

update.FileProgressBar

Updates file progress bar

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

patchCode

Patches installed and loaded packages and more

setThreshold.Verbose

Sets verbose threshold

update.ProgressBar

Updates progress bar

readShort.Java

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

ruler.Verbose

Writes a ruler

getTimestampFormat.Verbose

Gets the default timestamp format

intToBin

Converts an integer to a binary/octal/hexadecimal number

readRdHelp

Reads one or more Rd help files in a certain format

writeUTF.Java

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

reset.VComments

Resets a VComments compiler

readInt.Java

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

seqToIntervals

Gets all contigous intervals of a vector of indices

readUTF.Java

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

whichVector.logical

Identifies TRUE elements in a logical vector

timestampOn.Verbose

Turns automatic timestamping on and off

setStepLength.ProgressBar

Sets default step length

writeInt.Java

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