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

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

163,892

Version

1.4.2

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

June 13th, 2010

Functions in R.utils (1.4.2)

evaluate.Verbose

Evaluates a function and prints its results if above threshold

Sys.setenv

capture.Verbose

Captures output of a function

devOff

Closes a device

findGraphicsDevice.System

Searches for a working PNG device

as.character.Options

Returns a character string version of this object

callHooks

Call hook functions by hook name

GString

Character string with advanced substitutions

getReadablePathnames.Arguments

Gets a readable pathname

check.Assert

Static method asserting that a generic condition is true

SmartComments

Abstract class SmartComments

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

convertComment.VComments

Converts a verbose comment to R code

names.Options

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

attachLocally.list

Assigns an objects elements locally

as.character.GString

Gets the processed character string

getLabel.TextStatusBar

Gets the current value of a label

capitalize

Capitalizes/decapitalizes each character string in a vector

FileProgressBar

A progress bar that sets the size of a file accordingly

callHooks.function

Call hook functions

countLines

Counts the number of lines in a text file

Verbose

Class to writing verbose messages to a connection or file

getBuiltinDatetime.GString

Gets the current date and time

displayCode

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

getRegularExpression.Arguments

Gets a valid regular expression pattern

readByte.Java

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

isDirectory

Checks if the file specification is a directory

increase.ProgressBar

Increases (steps) progress bar

reset.SmartComments

Resets a SmartComments compiler

enter.Verbose

Writes a message and indents the following output

getBarString.ProgressBar

Gets the progress bar string to be displayed

getVector.Arguments

Validates a vector

getEnvironment.Arguments

Gets an existing environment

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

arrayIndex

Converts vector indices to array indices

jpeg2

A JPEG device for Bitmap Files via GhostScript

doCall

Executes a function call with option to ignore unused arguments

isScalar.Assert

Static method asserting thatan object is a single value

as.double.Verbose

Gets a numeric value of this object

commandArgs

Extract Command Line Arguments

moveInSearchPath

Moves a environment in the search path to another position

setOption.Options

Sets an option

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

devSet

Activates a device

cat.Verbose

Concatenates and prints objects if above threshold

R.utils-package

Package R.utils

dataFrame

Allocates a data frame with given column classes

patchCode

Patches installed and loaded packages and more

listDirectory

Gets the file names in the directory

header.Verbose

Writes a header

setLabels.TextStatusBar

Sets new values of given labels

flush.TextStatusBar

Flushes the output

getReadablePathname.Arguments

Gets a readable pathname

devNew

Opens a new device

dimNA< -

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

copyDirectory

Copies a directory

getBuiltinRhome.GString

Gets the path where R is installed

str.Options

Prints the structure of the options

intToBin

Converts an integer to a binary/octal/hexadecimal number

Settings

Class for applicational settings

colClasses

Creates a vector of column classes used for tabular reading

Non-documented objects

getLogicals.Arguments

Coerces to a logical vector and validates

devGetLabel

Gets the label of a device

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

isDone.ProgressBar

Checks if progress bar is completed

exit.Verbose

Writes a message and unindents the following output

findSettings.Settings

Searches for the settings file in one or several directories

convertComment.SmartComments

Converts a single smart comment to R code

as.character.ProgressBar

Gets a string description of the progress bar

as.list.Options

Gets a list representation of the options

devList

Lists the indices of the open devices named by their labels

as.logical.Verbose

Gets a logical value of this object

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

asLong.Java

Converts a numeric to a Java long

downloadFile.character

A Verbose class ignoring everything

png2

A PNG device for Bitmap Files via GhostScript

setStepLength.ProgressBar

Sets default step length

setThreshold.Verbose

Sets verbose threshold

writeRaw.Verbose

Writes objects if above threshold

currentTimeMillis.System

Get the current time in milliseconds

isVisible.Verbose

Checks if a certain verbose level will be shown or not

inAnyInterval.numeric

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

devSetLabel

Sets the label of a device

getBuiltinDate.GString

Gets the current date

setDefaultLevel.Verbose

Sets the current default verbose level

hasOption.Options

Checks if an option exists

isPackageLoaded

Checks if a package is loaded or not

pushState.Verbose

Pushes the current indentation state of the Verbose object

VComments

The VComments class

getBuiltinRversion.GString

Gets the current R version

getCharacters.Arguments

Coerces to a character vector and validates

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

isFile

Checks if the file specification is a file

isMatrix.Assert

Static method asserting thatan object is a matrix

Java

Static class for Java related methods

detachPackage

Detaches a packages by name

off.Verbose

Turn off the output

isOpen.character

Checks if there is an open connection to a file

mkdirs

Creates a directory including any necessary but nonexistent parent directories

getRelativePath

Gets the relative pathname relative to a directory

lapply.MultiVerbose

Applies a function to each of the Verbose objects

equals.Verbose

Checks if this object is equal to another

writeRaw.MultiVerbose

Writes to each of the Verbose objects

loadToEnv

Method to load objects to a new environment

asByte.Java

Converts a numeric to a Java byte

filePath

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

getBuiltinOs.GString

Gets the operating system of the running machine

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

isOn.Verbose

Checks if the output is on

writeByte.Java

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

getVerbose.Arguments

Coerces to Verbose object

openBrowser.System

Opens an HTML document using the OS default HTML browser

setLabel.TextStatusBar

Sets the value of a label

isAbsolutePath

Checks if this pathname is absolute

setTicks.ProgressBar

Sets values for which ticks should be visible

onGarbageCollect

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

getThreshold.Verbose

Gets current verbose threshold

getBuiltinPid.GString

Gets the process id of the current R session

summary.Verbose

Generates a summary of an object if above threshold

isZero

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

getRaw.GString

Gets the unprocessed GString

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

isPackageInstalled

Checks if a package is installed or not

isModified.Settings

Checks if settings has been modified compared to whats on file

more.Verbose

Creates a cloned instance with a lower threshold

readTableIndex

Reads a single column from file in table format

findSourceTraceback

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

getInstanceOf.Arguments

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

Method to load object from a file or a connection

asInt.Java

Converts an numeric to a Java integer

printf

C-style formatted output

finalizeSession

Function to call for finalizing the R session

bunzip2

Bunzip a file

getIntegers.Arguments

Coerces to a integer vector and validates

onSessionExit

Registers a function to be called when the R session finishes

printf.Verbose

Formats and prints object if above threshold

getUsername.System

Retrieves the name of the user running R

toCamelCase

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

loadAnywhere.Settings

Loads settings from file

gzip

Gzip/Gunzip a file

sourceDirectory

Sources files recursively to either local or global environment

createLink

Creates a link to a file or a directory

update.FileProgressBar

Updates file progress bar

print.Verbose

Prints objects if above threshold

getVariableValue.GString

Gets a variable value given a name and attributes

reset.ProgressBar

Reset progress bar

getWritablePathname.Arguments

Gets a writable pathname

getDoubles.Arguments

Coerces to a double vector and validates

warnings.Verbose

Outputs any warnings recorded

subplots

Creates a grid of subplots

equals.Options

Checks if this object is equal to another Options object

wrap.array

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

eps

EPS graphics device

readTable

Reads a file in table format

inherits.Assert

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

mergeIntervals.numeric

Merges intervals

isVector.Assert

Static method asserting thatan object is a vector

isUrl

Checks if one or several pathnames is URLs

getParent

Gets the string of the parent specified by this pathname

mapToIntervals.numeric

Maps values to intervals

isOn.NullVerbose

Checks if the output is on

newline.TextStatusBar

Writes a newline

validate.SmartComments

Validates the compiled lines

print.GString

Prints the processed GString

getOption.Options

Gets an option

writeUTF.Java

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

toUrl

Converts a pathname into a URL

readUTF.Java

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

saveAnywhere.Settings

Saves settings to file

readShort.Java

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

parse.GString

Parses a GString

update.TextStatusBar

Updates the status bar (visually)

sourceTo

Parses and evaluates code from a file or a connection

getTimestampFormat.Verbose

Gets the default timestamp format

popMessage.TextStatusBar

Adds a message above the status bar

setTimestampFormat.Verbose

Sets the default timestamp format

touchFile

Updates the timestamp of a file

reassignInPackage

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

resetWarnings

Resets recorded warnings

writeShort.Java

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

remove.FileProgressBar

Removes the progress file for a file progress bar

readInt.Java

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

less.Verbose

Creates a cloned instance with a higher threshold

str.Verbose

Prints the structure of an object if above threshold

promptAndSave.Settings

Prompt user to save modified settings

relibrary

Reloads a package

timestampOn.Verbose

Turns automatic timestamping on and off

readBinFragments

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

ruler.Verbose

Writes a ruler

reset.VComments

Resets a VComments compiler

saveObject

Saves an object to a file or a connection

validate.VComments

Validates the compiled lines

splitByPattern

Splits a single character string by pattern

writeInt.Java

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

asShort.Java

Converts a numeric to a Java short

Arguments

Static class to validate and process arguments

Options

The Options class

NullVerbose

A Verbose class ignoring everything

as.character.Verbose

Returns a character string version of this object

ProgressBar

Provides text based counting progress bar

compile.SmartComments

Preprocess a vector of code lines

devIsOpen

Checks if a device is open or not

getBuiltinTime.GString

Gets the current time

newline.Verbose

Writes one or several empty lines

extract.array

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

nbrOfOptions.Options

Gets the number of options set

getHostname.System

Retrieves the computer name of the current host

System

Static class to query information about the system

removeDirectory

Removes a directory

devDone

Closes an on-screen (interactive) device

whichVector.logical

Identifies TRUE elements in a logical vector

LComments

The LComments class

getNumerics.Arguments

Coerces to a numeric vector and validates

lastModified

Gets the time when the file was last modified

insert

Insert values to a vector at certain positions

getAbsolutePath

Gets the absolute pathname string

findGhostscript.System

Searches for the ghostview binary on the current system

unwrap.array

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

getBuiltinHostname.GString

Gets the hostname of the system running R

getBuiltinUsername.GString

Gets the username of the user running R

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

writeBinFragments

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

timestamp.Verbose

Writes a timestamp

getIndices.Arguments

Coerces to a integer vector and validates

seqToHumanReadable

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

parse.SmartComments

Parses one single smart comment

setMaxValue.ProgressBar

Sets maximum value

updateLabels.TextStatusBar

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

isEof.connection

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

getLeaves.Options

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

setValue.ProgressBar

Sets current value

seqToIntervals

Gets all contigous intervals of a vector of indices

setProgress.ProgressBar

Sets current progress

TextStatusBar

A status bar at the R prompt that can be updated

fileAccess

Checks the permission of a file or a directory