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

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

227,712

Version

1.6.4

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

March 3rd, 2011

Functions in R.utils (1.6.4)

as.character.Verbose

Returns a character string version of this object

asLong.Java

Converts a numeric to a Java long

callHooks

Call hook functions by hook name

devNew

Opens a new device

FileProgressBar

A progress bar that sets the size of a file accordingly

SmartComments

Abstract class SmartComments

GString

Character string with advanced substitutions

devSet

Activates a device

displayCode

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

getMessage.TimeoutException

Gets the message of the exception

equals.Verbose

Checks if this object is equal to another

doCall

Executes a function call with option to ignore unused arguments

extract.array

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

convertComment.VComments

Converts a verbose comment to R code

enter.Verbose

Writes a message and indents the following output

getLabel.TextStatusBar

Gets the current value of a label

createFileAtomically

Creates a file atomically

hasOption.Options

Checks if an option exists

countLines

Counts the number of lines in a text file

evaluate.Verbose

Evaluates a function and prints its results if above threshold

exit.Verbose

Writes a message and unindents the following output

devGetLabel

Gets the label of a device

findSettings.Settings

Searches for the settings file in one or several directories

onSessionExit

Registers a function to be called when the R session finishes

getBuiltinPid.GString

Gets the process id of the current R session

Arguments

Static class to validate and process arguments

cat.Verbose

Concatenates and prints objects if above threshold

inAnyInterval.numeric

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

devOff

Closes a device

devList

Lists the indices of the open devices named by their labels

getIntegers.Arguments

Coerces to a integer vector and validates

getBuiltinRversion.GString

Gets the current R version

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

getReadablePathnames.Arguments

Gets a readable pathname

isOn.Verbose

Checks if the output is on

isDone.ProgressBar

Checks if progress bar is completed

reset.ProgressBar

Reset progress bar

jpeg2

A JPEG device for Bitmap Files via GhostScript

isEof.connection

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

evalWithTimeout

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

getParent

Gets the string of the parent specified by this pathname

readRdHelp

Reads one or more Rd help files in a certain format

equals.Options

Checks if this object is equal to another Options object

loadAnywhere.Settings

Loads settings from file

readShort.Java

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

nbrOfOptions.Options

Gets the number of options set

patchCode

Patches installed and loaded packages and more

printf.Verbose

Formats and prints object if above threshold

listDirectory

Gets the file names in the directory

attachLocally.list

Assigns an objects elements locally

getAbsolutePath

Gets the absolute pathname string

dataFrame

Allocates a data frame with given column classes

getBuiltinDate.GString

Gets the current date

getDoubles.Arguments

Coerces to a double vector and validates

onGarbageCollect

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

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

getBuiltinOs.GString

Gets the operating system of the running machine

setValue.ProgressBar

Sets current value

stext

Writes text in the margin along the sides of a plot

saveAnywhere.Settings

Saves settings to file

setDefaultLevel.Verbose

Sets the current default verbose level

gzip

Gzip/Gunzip a file

as.double.Verbose

Gets a numeric value of this object

setMaxValue.ProgressBar

Sets maximum value

getBuiltinTime.GString

Gets the current time

getWritablePathname.Arguments

Gets a writable pathname

header.Verbose

Writes a header

sourceDirectory

Sources files recursively to either local or global environment

readTable

Reads a file in table format

sourceTo

Parses and evaluates code from a file or a connection

seqToIntervals

Gets all contigous intervals of a vector of indices

removeDirectory

Removes a directory

remove.FileProgressBar

Removes the progress file for a file progress bar

str.Verbose

Prints the structure of an object if above threshold

setProgress.ProgressBar

Sets current progress

validate.SmartComments

Validates the compiled lines

isVector.Assert

Static method asserting thatan object is a vector

warnings.Verbose

Outputs any warnings recorded

more.Verbose

Creates a cloned instance with a lower threshold

relibrary

Reloads a package

less.Verbose

Creates a cloned instance with a higher threshold

Static method asserting thatan object is a matrix

setStepLength.ProgressBar

Sets default step length

setLabels.TextStatusBar

Sets new values of given labels

arrayIndex

Converts vector indices to array indices

update.ProgressBar

Updates progress bar

getIndices.Arguments

Coerces to a integer vector and validates

devDone

Closes an on-screen (interactive) device

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

getCharacters.Arguments

Coerces to a character vector and validates

isZero

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

getBarString.ProgressBar

Gets the progress bar string to be displayed

timestampOn.Verbose

Turns automatic timestamping on and off

print.GString

Prints the processed GString

getLeaves.Options

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

str.Options

Prints the structure of the options

NullVerbose

A Verbose class ignoring everything

validate.VComments

Validates the compiled lines

flush.TextStatusBar

Flushes the output

as.list.Options

Gets a list representation of the options

timestamp.Verbose

Writes a timestamp

reset.VComments

Resets a VComments compiler

getLogicals.Arguments

Coerces to a logical vector and validates

toCamelCase

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

commandArgs

Extract Command Line Arguments

getNumerics.Arguments

Coerces to a numeric vector and validates

findGraphicsDevice.System

Searches for a working PNG device

getRelativePath

Gets the relative pathname relative to a directory

getRegularExpression.Arguments

Gets a valid regular expression pattern

getVariableValue.GString

Gets a variable value given a name and attributes

TimeoutException

TimeoutException represents timeout errors

writeUTF.Java

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

LComments

The LComments class

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

names.Options

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

isOpen.character

Checks if there is an open connection to a file

as.logical.Verbose

Gets a logical value of this object

printf

C-style formatted output

popMessage.TextStatusBar

Adds a message above the status bar

convertComment.SmartComments

Converts a single smart comment to R code

print.Verbose

Prints objects if above threshold

TextStatusBar

A status bar at the R prompt that can be updated

Static method asserting that a generic condition is true

isFile

Checks if the file specification is a file

asByte.Java

Converts a numeric to a Java byte

createLink

Creates a link to a file or a directory

parse.GString

Parses a GString

moveInSearchPath

Moves a environment in the search path to another position

currentTimeMillis.System

Get the current time in milliseconds

asInt.Java

Converts an numeric to a Java integer

as.character.GString

Gets the processed character string

promptAndSave.Settings

Prompt user to save modified settings

eps

EPS graphics device

resetWarnings

Resets recorded warnings

capitalize

Capitalizes/decapitalizes each character string in a vector

copyFile

Copies a file safely

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

loadToEnv

Method to load objects to a new environment

reset.SmartComments

Resets a SmartComments compiler

getBuiltinRhome.GString

Gets the path where R is installed

compile.SmartComments

Preprocess a vector of code lines

summary.Verbose

Generates a summary of an object if above threshold

getInstanceOf.Arguments

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

newline.Verbose

Writes one or several empty lines

inherits.Assert

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

setOption.Options

Sets an option

lapply.MultiVerbose

Applies a function to each of the Verbose objects

detachPackage

Detaches a packages by name

writeRaw.NullVerbose

All output methods

isOn.NullVerbose

Checks if the output is on

writeBinFragments

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

dimNA< -

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

touchFile

Updates the timestamp of a file

writeShort.Java

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

wrap.array

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

isScalar.Assert

Static method asserting thatan object is a single value

openBrowser.System

Opens an HTML document using the OS default HTML browser

isDirectory

Checks if the file specification is a directory

asShort.Java

Converts a numeric to a Java short

getEnvironment.Arguments

Gets an existing environment

System

Static class to query information about the system

pushTemporaryFile

Appends a temporary suffix to the pathname

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

Non-documented objects

Settings

Class for applicational settings

fileAccess

Checks the permission of a file or a directory

isVisible.Verbose

Checks if a certain verbose level will be shown or not

findGhostscript.System

Searches for the ghostview binary on the current system

colClasses

Creates a vector of column classes used for tabular reading

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

mkdirs

Creates a directory including any necessary but nonexistent parent directories

insert

Insert values to a vector at certain positions

pushState.Verbose

Pushes the current indentation state of the Verbose object

isPackageLoaded

Checks if a package is loaded or not

on.Verbose

Turn on the output

intToBin

Converts an integer to a binary/octal/hexadecimal number

loadObject

Method to load object from a file or a connection

Verbose

Class to writing verbose messages to a connection or file

readInt.Java

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

popTemporaryFile

Drops a temporary suffix from the temporary pathname

saveObject

Saves an object to a file or a connection

setLabel.TextStatusBar

Sets the value of a label

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

setTicks.ProgressBar

Sets values for which ticks should be visible

writeRaw.Verbose

Writes objects if above threshold

devSetLabel

Sets the label of a device

Java

Static class for Java related methods

isAbsolutePath

Checks if this pathname is absolute

filePath

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

getVerbose.Arguments

Coerces to Verbose object

update.TextStatusBar

Updates the status bar (visually)

seqToHumanReadable

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

getTimestampFormat.Verbose

Gets the default timestamp format

off.Verbose

Turn off the output

update.FileProgressBar

Updates file progress bar

whichVector.logical

Identifies TRUE elements in a logical vector

writeRaw.MultiVerbose

Writes to each of the Verbose objects

updateLabels.TextStatusBar

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

finalizeSession

Function to call for finalizing the R session

readBinFragments

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

ProgressBar

Provides text based counting progress bar

devIsOpen

Checks if a device is open or not

parse.SmartComments

Parses one single smart comment

mapToIntervals.numeric

Maps values to intervals

writeByte.Java

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

devEval

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

as.character.ProgressBar

Gets a string description of the progress bar

capture.Verbose

Captures output of a function

copyDirectory

Copies a directory

as.character.Options

Returns a character string version of this object

Assert

The Assert class

getBuiltinUsername.GString

Gets the username of the user running R

bunzip2

Bunzip a file

isPackageInstalled

Checks if a package is installed or not

getRaw.GString

Gets the unprocessed GString

lastModified

Gets the time when the file was last modified

isUrl

Checks if one or several pathnames is URLs

getReadablePathname.Arguments

Gets a readable pathname

newline.TextStatusBar

Writes a newline

resample

Sample values from a set of elements

mergeIntervals.numeric

Merges intervals

readTableIndex

Reads a single column from file in table format

splitByPattern

Splits a single character string by pattern

getUsername.System

Retrieves the name of the user running R

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

downloadFile.character

Downloads a file

getBuiltinDatetime.GString

Gets the current date and time

getHostname.System

Retrieves the computer name of the current host

getVector.Arguments

Validates a vector

increase.ProgressBar

Increases (steps) progress bar

getOption.Options

Gets an option

reassignInPackage

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

setTimestampFormat.Verbose

Sets the default timestamp format

toUrl

Converts a pathname into a URL

MultiVerbose

A Verbose class ignoring everything

getBuiltinHostname.GString

Gets the hostname of the system running R

findSourceTraceback

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

isModified.Settings

Checks if settings has been modified compared to whats on file

getThreshold.Verbose

Gets current verbose threshold

png2

A PNG device for Bitmap Files via GhostScript

ruler.Verbose

Writes a ruler

readUTF.Java

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

subplots

Creates a grid of subplots

unwrap.array

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

writeInt.Java

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

setThreshold.Verbose

Sets verbose threshold

readByte.Java

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