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

R.utils (version 1.3.2)

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

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

January 22nd, 2010

Functions in R.utils (1.3.2)

FileProgressBar

A progress bar that sets the size of a file accordingly

commandArgs

Extract Command Line Arguments

LComments

The LComments class

as.character.GString

Gets the processed character string

Sys.setenv

convertComment.VComments

Converts a verbose comment to R code

GString

Character string with advanced substitutions

NullVerbose

A Verbose class ignoring everything

System

Static class to query information about the system

createLink

Creates a link to a file or a directory

Settings

Class for applicational settings

asLong.Java

Converts a numeric to a Java long

devSetLabel

Sets the label of a device

Assert

The Assert class

SmartComments

Abstract class SmartComments

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

Verbose

Class to writing verbose messages to a connection or file

capture.Verbose

Captures output of a function

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

cat.Verbose

Concatenates and prints objects if above threshold

as.logical.Verbose

Gets a logical value of this object

capitalize

Capitalizes/decapitalizes each character string in a vector

filePath

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

equals.Verbose

Checks if this object is equal to another

isDirectory

Checks if the file specification is a directory

extract.array

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

attachLocally.list

Assigns an objects elements locally

asInt.Java

Converts an numeric to a Java integer

doCall

Executes a function call with option to ignore unused arguments

getBarString.ProgressBar

Gets the progress bar string to be displayed

findSettings.Settings

Searches for the settings file in one or several directories

getOption.Options

Gets an option

devList

Lists the indices of the open devices named by their labels

finalizeSession

Function to call for finalizing the R session

as.character.Verbose

Returns a character string version of this object

getIndices.Arguments

Coerces to a integer vector and validates

convertComment.SmartComments

Converts a single smart comment to R code

getLeaves.Options

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

dimNA< -

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

listDirectory

Gets the file names in the directory

as.character.ProgressBar

Gets a string description of the progress bar

getEnvironment.Arguments

Gets an existing environment

as.list.Options

Gets a list representation of the options

getBuiltinUsername.GString

Gets the username of the user running R

compile.SmartComments

Preprocess a vector of code lines

findSourceTraceback

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

getBuiltinPid.GString

Gets the process id of the current R session

Non-documented objects

getThreshold.Verbose

Gets current verbose threshold

getBuiltinHostname.GString

Gets the hostname of the system running R

evaluate.Verbose

Evaluates a function and prints its results if above threshold

getVerbose.Arguments

Coerces to Verbose object

getWritablePathname.Arguments

Gets a writable pathname

fileAccess

Checks the permission of a file or a directory

getInstanceOf.Arguments

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

TextStatusBar

A status bar at the R prompt that can be updated

getDoubles.Arguments

Coerces to a double vector and validates

isMatrix.Assert

Static method asserting thatan object is a matrix

readUTF.Java

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

setTimestampFormat.Verbose

Sets the default timestamp format

getParent

Gets the string of the parent specified by this pathname

seqToHumanReadable

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

getCharacters.Arguments

Coerces to a character vector and validates

lastModified

Gets the time when the file was last modified

getBuiltinTime.GString

Gets the current time

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

devDone

Closes an on-screen (interactive) device

getTimestampFormat.Verbose

Gets the default timestamp format

jpeg2

A JPEG device for Bitmap Files via GhostScript

getNumerics.Arguments

Coerces to a numeric vector and validates

as.double.Verbose

Gets a numeric value of this object

update.TextStatusBar

Updates the status bar (visually)

colClasses

Creates a vector of column classes used for tabular reading

getRaw.GString

Gets the unprocessed GString

bunzip2

Bunzip a file

more.Verbose

Creates a cloned instance with a lower threshold

hasOption.Options

Checks if an option exists

callHooks

Call hook functions by hook name

check.Assert

Static method asserting that a generic condition is true

copyDirectory

Copies a directory

asShort.Java

Converts a numeric to a Java short

Java

Static class for Java related methods

Arguments

Static class to validate and process arguments

getLabel.TextStatusBar

Gets the current value of a label

VComments

The VComments class

as.character.Options

Returns a character string version of this object

Gets the operating system of the running machine

getAbsolutePath

Gets the absolute pathname string

increase.ProgressBar

Increases (steps) progress bar

onSessionExit

Registers a function to be called when the R session finishes

names.Options

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

isModified.Settings

Checks if settings has been modified compared to whats on file

devSet

Activates a device

getLogicals.Arguments

Coerces to a logical vector and validates

isOpen.character

Checks if there is an open connection to a file

header.Verbose

Writes a header

dataFrame

Allocates a data frame with given column classes

devOff

Closes a device

isVisible.Verbose

Checks if a certain verbose level will be shown or not

loadAnywhere.Settings

Loads settings from file

update.FileProgressBar

Updates file progress bar

relibrary

Reloads a package

setProgress.ProgressBar

Sets current progress

equals.Options

Checks if this object is equal to another Options object

getBuiltinDatetime.GString

Gets the current date and time

subplots

Creates a grid of subplots

whichVector.logical

Identifies TRUE elements in a logical vector

exit.Verbose

Writes a message and unindents the following output

countLines

Counts the number of lines in a text file

mergeIntervals.numeric

Merges intervals

isOn.Verbose

Checks if the output is on

writeBinFragments

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

writeShort.Java

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

getVariableValue.GString

Gets a variable value given a name and attributes

getReadablePathnames.Arguments

Gets a readable pathname

toCamelCase

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

getBuiltinDate.GString

Gets the current date

getRegularExpression.Arguments

Gets a valid regular expression pattern

isOn.NullVerbose

Checks if the output is on

loadObject

Method to load object from a file or a connection

isAbsolutePath

Checks if this pathname is absolute

ruler.Verbose

Writes a ruler

isFile

Checks if the file specification is a file

setValue.ProgressBar

Sets current value

readShort.Java

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

findGhostscript.System

Searches for the ghostview binary on the current system

setMaxValue.ProgressBar

Sets maximum value

setThreshold.Verbose

Sets verbose threshold

isPackageInstalled

Checks if a package is installed or not

splitByPattern

Splits a single character string by pattern

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

less.Verbose

Creates a cloned instance with a higher threshold

reset.SmartComments

Resets a SmartComments compiler

saveAnywhere.Settings

Saves settings to file

findGraphicsDevice.System

Searches for a working PNG device

writeInt.Java

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

summary.Verbose

Generates a summary of an object if above threshold

isVector.Assert

Static method asserting thatan object is a vector

getBuiltinRversion.GString

Gets the current R version

nbrOfOptions.Options

Gets the number of options set

readByte.Java

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

getIntegers.Arguments

Coerces to a integer vector and validates

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

insert

Insert values to a vector at certain positions

writeRaw.MultiVerbose

Writes to each of the Verbose objects

isZero

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

saveObject

Saves an object to a file or a connection

sourceTo

Parses and evaluates code from a file or a connection

openBrowser.System

Opens an HTML document using the OS default HTML browser

lapply.MultiVerbose

Applies a function to each of the Verbose objects

remove.FileProgressBar

Removes the progress file for a file progress bar

png2

A PNG device for Bitmap Files via GhostScript

loadToEnv

Method to load objects to a new environment

update.ProgressBar

Updates progress bar

promptAndSave.Settings

Prompt user to save modified settings

seqToIntervals

Gets all contigous intervals of a vector of indices

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

newline.TextStatusBar

Writes a newline

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

parse.SmartComments

Parses one single smart comment

getVector.Arguments

Validates a vector

print.GString

Prints the processed GString

off.Verbose

Turn off the output

mkdirs

Creates a directory including any necessary but nonexistent parent directories

setLabels.TextStatusBar

Sets new values of given labels

popMessage.TextStatusBar

Adds a message above the status bar

Checks if progress bar is completed

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

pushState.Verbose

Pushes the current indentation state of the Verbose object

sourceDirectory

Sources files recursively to either local or global environment

validate.SmartComments

Validates the compiled lines

setTicks.ProgressBar

Sets values for which ticks should be visible

updateLabels.TextStatusBar

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

readInt.Java

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

isEof.connection

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

printf.Verbose

Formats and prints object if above threshold

readTableIndex

Reads a single column from file in table format

str.Verbose

Prints the structure of an object if above threshold

setStepLength.ProgressBar

Sets default step length

timestamp.Verbose

Writes a timestamp

print.Verbose

Prints objects if above threshold

warnings.Verbose

Outputs any warnings recorded

isUrl

Checks if one or several pathnames is URLs

resetWarnings

Resets recorded warnings

touchFile

Updates the timestamp of a file

validate.VComments

Validates the compiled lines

writeRaw.Verbose

Writes objects if above threshold

setDefaultLevel.Verbose

Sets the current default verbose level

newline.Verbose

Writes one or several empty lines

readTable

Reads a file in table format

str.Options

Prints the structure of the options

setLabel.TextStatusBar

Sets the value of a label

removeDirectory

Removes a directory

unwrap.array

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

writeUTF.Java

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

patchCode

Patches installed and loaded packages and more

wrap.array

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

writeByte.Java

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

mapToIntervals.numeric

Maps values to intervals

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

asByte.Java

Converts a numeric to a Java byte

callHooks.function

Call hook functions

arrayIndex

Converts vector indices to array indices

getHostname.System

Retrieves the computer name of the current host

parse.GString

Parses a GString

toUrl

Converts a pathname into a URL

Options

The Options class

ProgressBar

Provides text based counting progress bar

flush.TextStatusBar

Flushes the output

getReadablePathname.Arguments

Gets a readable pathname

inherits.Assert

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

isScalar.Assert

Static method asserting thatan object is a single value

reassignInPackage

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

reset.VComments

Resets a VComments compiler

setOption.Options

Sets an option

MultiVerbose

A Verbose class ignoring everything

detachPackage

Detaches a packages by name

devGetLabel

Gets the label of a device

copyFile

Copies a file safely

getBuiltinRhome.GString

Gets the path where R is installed

inAnyInterval.numeric

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

getRelativePath

Gets the relative pathname relative to a directory

isPackageLoaded

Checks if a package is loaded or not

readBinFragments

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

devIsOpen

Checks if a device is open or not

currentTimeMillis.System

Get the current time in milliseconds

devNew

Opens a new device

displayCode

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

enter.Verbose

Writes a message and indents the following output

getUsername.System

Retrieves the name of the user running R

intToBin

Converts an integer to a binary/octal/hexadecimal number

moveInSearchPath

Moves a environment in the search path to another position

timestampOn.Verbose

Turns automatic timestamping on and off