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

R.utils (version 1.3.0)

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.3.0

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

January 3rd, 2010

Functions in R.utils (1.3.0)

as.list.Options

Gets a list representation of the options

NullVerbose

A Verbose class ignoring everything

callHooks

Call hook functions by hook name

cat.Verbose

Concatenates and prints objects if above threshold

Java

Static class for Java related methods

FileProgressBar

A progress bar that sets the size of a file accordingly

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

getBuiltinTime.GString

Gets the current time

ProgressBar

Provides text based counting progress bar

copyDirectory

Copies a directory

asInt.Java

Converts an numeric to a Java integer

evaluate.Verbose

Evaluates a function and prints its results if above threshold

as.double.Verbose

Gets a numeric value of this object

MultiVerbose

A Verbose class ignoring everything

asLong.Java

Converts a numeric to a Java long

devDone

Closes an on-screen (interactive) device

getEnvironment.Arguments

Gets an existing environment

getThreshold.Verbose

Gets current verbose threshold

Abstract class SmartComments

displayCode

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

getBuiltinHostname.GString

Gets the hostname of the system running R

getParent

Gets the string of the parent specified by this pathname

getLeaves.Options

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

Settings

Class for applicational settings

devOff

Closes a device

arrayIndex

Converts vector indices to array indices

detachPackage

Detaches a packages by name

Arguments

Static class to validate and process arguments

isVector.Assert

Static method asserting thatan object is a vector

System

Static class to query information about the system

bunzip2

Bunzip a file

Sys.setenv

getCharacters.Arguments

Coerces to a character vector and validates

as.character.ProgressBar

Gets a string description of the progress bar

findGraphicsDevice.System

Searches for a working PNG device

getBuiltinDate.GString

Gets the current date

as.logical.Verbose

Gets a logical value of this object

lastModified

Gets the time when the file was last modified

loadObject

Method to load object from a file or a connection

getWritablePathname.Arguments

Gets a writable pathname

print.GString

Prints the processed GString

getIntegers.Arguments

Coerces to a integer vector and validates

as.character.Options

Returns a character string version of this object

asByte.Java

Converts a numeric to a Java byte

isOn.NullVerbose

Checks if the output is on

GString

Character string with advanced substitutions

remove.FileProgressBar

Removes the progress file for a file progress bar

attachLocally.list

Assigns an objects elements locally

loadAnywhere.Settings

Loads settings from file

compile.SmartComments

Preprocess a vector of code lines

isScalar.Assert

Static method asserting thatan object is a single value

dataFrame

Allocates a data frame with given column classes

exit.Verbose

Writes a message and unindents the following output

Assert

The Assert class

getBuiltinPid.GString

Gets the process id of the current R session

getBuiltinDatetime.GString

Gets the current date and time

convertComment.SmartComments

Converts a single smart comment to R code

fileAccess

Checks the permission of a file or a directory

TextStatusBar

A status bar at the R prompt that can be updated

readTableIndex

Reads a single column from file in table format

commandArgs

Extract Command Line Arguments

convertComment.VComments

Converts a verbose comment to R code

findSourceTraceback

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

colClasses

Creates a vector of column classes used for tabular reading

pushState.Verbose

Pushes the current indentation state of the Verbose object

as.character.Verbose

Returns a character string version of this object

reset.SmartComments

Resets a SmartComments compiler

enter.Verbose

Writes a message and indents the following output

as.character.GString

Gets the processed character string

VComments

The VComments class

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

createLink

Creates a link to a file or a directory

inherits.Assert

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

check.Assert

Static method asserting that a generic condition is true

print.Verbose

Prints objects if above threshold

Options

The Options class

capture.Verbose

Captures output of a function

getAbsolutePath

Gets the absolute pathname string

capitalize

Capitalizes/decapitalizes each character string in a vector

currentTimeMillis.System

Get the current time in milliseconds

getBuiltinRhome.GString

Gets the path where R is installed

devSet

Activates a device

devList

Lists the indices of the open devices named by their labels

dimNA< -

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

getNumerics.Arguments

Coerces to a numeric vector and validates

validate.VComments

Validates the compiled lines

equals.Verbose

Checks if this object is equal to another

Checks if a device is open or not

getBuiltinRversion.GString

Gets the current R version

getLogicals.Arguments

Coerces to a logical vector and validates

findSettings.Settings

Searches for the settings file in one or several directories

popMessage.TextStatusBar

Adds a message above the status bar

timestamp.Verbose

Writes a timestamp

getUsername.System

Retrieves the name of the user running R

getBarString.ProgressBar

Gets the progress bar string to be displayed

sourceTo

Parses and evaluates code from a file or a connection

getDoubles.Arguments

Coerces to a double vector and validates

getRegularExpression.Arguments

Gets a valid regular expression pattern

getVerbose.Arguments

Coerces to Verbose object

countLines

Counts the number of lines in a text file

getRaw.GString

Gets the unprocessed GString

mapToIntervals.numeric

Maps values to intervals

isDirectory

Checks if the file specification is a directory

str.Options

Prints the structure of the options

wrap.array

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

isAbsolutePath

Checks if this pathname is absolute

isOn.Verbose

Checks if the output is on

setLabels.TextStatusBar

Sets new values of given labels

on.Verbose

Turn on the output

saveAnywhere.Settings

Saves settings to file

jpeg2

A JPEG device for Bitmap Files via GhostScript

extract.array

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

png2

A PNG device for Bitmap Files via GhostScript

reassignInPackage

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

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

getBuiltinOs.GString

Gets the operating system of the running machine

onSessionExit

Registers a function to be called when the R session finishes

lapply.MultiVerbose

Applies a function to each of the Verbose objects

equals.Options

Checks if this object is equal to another Options object

unwrap.array

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

insert

Insert values to a vector at certain positions

getReadablePathname.Arguments

Gets a readable pathname

newline.Verbose

Writes one or several empty lines

setThreshold.Verbose

Sets verbose threshold

isUrl

Checks if one or several pathnames is URLs

readTable

Reads a file in table format

relibrary

Reloads a package

isPackageLoaded

Checks if a package is loaded or not

reset.VComments

Resets a VComments compiler

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

writeBinFragments

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

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

str.Verbose

Prints the structure of an object if above threshold

getHostname.System

Retrieves the computer name of the current host

setTimestampFormat.Verbose

Sets the default timestamp format

splitByPattern

Splits a single character string by pattern

isVisible.Verbose

Checks if a certain verbose level will be shown or not

getInstanceOf.Arguments

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

writeRaw.Verbose

Writes objects if above threshold

sourceDirectory

Sources files recursively to either local or global environment

finalizeSession

Function to call for finalizing the R session

setProgress.ProgressBar

Sets current progress

readByte.Java

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

update.FileProgressBar

Updates file progress bar

nbrOfOptions.Options

Gets the number of options set

names.Options

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

isZero

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

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

header.Verbose

Writes a header

printf.Verbose

Formats and prints object if above threshold

updateLabels.TextStatusBar

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

off.Verbose

Turn off the output

inAnyInterval.numeric

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

getVariableValue.GString

Gets a variable value given a name and attributes

seqToIntervals

Gets all contigous intervals of a vector of indices

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

saveObject

Saves an object to a file or a connection

isEof.connection

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

less.Verbose

Creates a cloned instance with a higher threshold

increase.ProgressBar

Increases (steps) progress bar

hasOption.Options

Checks if an option exists

setDefaultLevel.Verbose

Sets the current default verbose level

writeByte.Java

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

promptAndSave.Settings

Prompt user to save modified settings

isDone.ProgressBar

Checks if progress bar is completed

parse.SmartComments

Parses one single smart comment

listDirectory

Gets the file names in the directory

validate.SmartComments

Validates the compiled lines

setValue.ProgressBar

Sets current value

setStepLength.ProgressBar

Sets default step length

touchFile

Updates the timestamp of a file

writeRaw.NullVerbose

All output methods

setLabel.TextStatusBar

Sets the value of a label

setTicks.ProgressBar

Sets values for which ticks should be visible

subplots

Creates a grid of subplots

reset.ProgressBar

Reset progress bar

isModified.Settings

Checks if settings has been modified compared to whats on file

openBrowser.System

Opens an HTML document using the OS default HTML browser

newline.TextStatusBar

Writes a newline

toCamelCase

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

readInt.Java

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

writeInt.Java

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

getIndices.Arguments

Coerces to a integer vector and validates

isPackageInstalled

Checks if a package is installed or not

update.TextStatusBar

Updates the status bar (visually)

seqToHumanReadable

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

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

update.ProgressBar

Updates progress bar

toUrl

Converts a pathname into a URL

readBinFragments

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

readShort.Java

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

timestampOn.Verbose

Turns automatic timestamping on and off

setMaxValue.ProgressBar

Sets maximum value

isFile

Checks if the file specification is a file

readUTF.Java

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

writeRaw.MultiVerbose

Writes to each of the Verbose objects

warnings.Verbose

Outputs any warnings recorded

setOption.Options

Sets an option

writeShort.Java

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

Verbose

Class to writing verbose messages to a connection or file

devGetLabel

Gets the label of a device

devSetLabel

Sets the label of a device

filePath

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

getReadablePathnames.Arguments

Gets a readable pathname

getTimestampFormat.Verbose

Gets the default timestamp format

loadToEnv

Method to load objects to a new environment

mergeIntervals.numeric

Merges intervals

patchCode

Patches installed and loaded packages and more

summary.Verbose

Generates a summary of an object if above threshold

resetWarnings

Resets recorded warnings

isMatrix.Assert

Static method asserting thatan object is a matrix

ruler.Verbose

Writes a ruler

whichVector.logical

Identifies TRUE elements in a logical vector

more.Verbose

Creates a cloned instance with a lower threshold

writeUTF.Java

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

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

Non-documented objects

findGhostscript.System

Searches for the ghostview binary on the current system

getBuiltinUsername.GString

Gets the username of the user running R

mkdirs

Creates a directory including any necessary but nonexistent parent directories

parse.GString

Parses a GString

getLabel.TextStatusBar

Gets the current value of a label

intToBin

Converts an integer to a binary/octal/hexadecimal number

doCall

Executes a function call with option to ignore unused arguments

isOpen.character

Checks if there is an open connection to a file

asShort.Java

Converts a numeric to a Java short

LComments

The LComments class

moveInSearchPath

Moves a environment in the search path to another position

getRelativePath

Gets the relative pathname relative to a directory