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

R.utils (version 1.5.3)

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

192,589

Version

1.5.3

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

September 30th, 2010

Functions in R.utils (1.5.3)

as.character.GString

Gets the processed character string

Arguments

Static class to validate and process arguments

Sys.setenv

cat.Verbose

Concatenates and prints objects if above threshold

Settings

Class for applicational settings

as.character.Options

Returns a character string version of this object

devGetLabel

Gets the label of a device

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

Non-documented objects

eps

EPS graphics device

Java

Static class for Java related methods

countLines

Counts the number of lines in a text file

fileAccess

Checks the permission of a file or a directory

as.character.ProgressBar

Gets a string description of the progress bar

devNew

Opens a new device

createLink

Creates a link to a file or a directory

System

Static class to query information about the system

getVector.Arguments

Validates a vector

TextStatusBar

A status bar at the R prompt that can be updated

hasOption.Options

Checks if an option exists

MultiVerbose

A Verbose class ignoring everything

filePath

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

getReadablePathname.Arguments

Gets a readable pathname

convertComment.SmartComments

Converts a single smart comment to R code

Assert

The Assert class

equals.Options

Checks if this object is equal to another Options object

callHooks

Call hook functions by hook name

openBrowser.System

Opens an HTML document using the OS default HTML browser

parse.GString

Parses a GString

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

asShort.Java

Converts a numeric to a Java short

getBuiltinDate.GString

Gets the current date

getEnvironment.Arguments

Gets an existing environment

as.logical.Verbose

Gets a logical value of this object

isScalar.Assert

Static method asserting thatan object is a single value

devDone

Closes an on-screen (interactive) device

exit.Verbose

Writes a message and unindents the following output

getIndices.Arguments

Coerces to a integer vector and validates

asInt.Java

Converts an numeric to a Java integer

inherits.Assert

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

findGhostscript.System

Searches for the ghostview binary on the current system

callHooks.function

Call hook functions

getUsername.System

Retrieves the name of the user running R

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

increase.ProgressBar

Increases (steps) progress bar

currentTimeMillis.System

Get the current time in milliseconds

Static method asserting that a generic condition is true

GString

Character string with advanced substitutions

copyFile

Copies a file safely

reset.VComments

Resets a VComments compiler

commandArgs

Extract Command Line Arguments

convertComment.VComments

Converts a verbose comment to R code

equals.Verbose

Checks if this object is equal to another

as.double.Verbose

Gets a numeric value of this object

getVerbose.Arguments

Coerces to Verbose object

isModified.Settings

Checks if settings has been modified compared to whats on file

as.list.Options

Gets a list representation of the options

lapply.MultiVerbose

Applies a function to each of the Verbose objects

NullVerbose

A Verbose class ignoring everything

getBuiltinHostname.GString

Gets the hostname of the system running R

devSetLabel

Sets the label of a device

png2

A PNG device for Bitmap Files via GhostScript

arrayIndex

Converts vector indices to array indices

doCall

Executes a function call with option to ignore unused arguments

downloadFile.character

Downloads a file

gzip

Gzip/Gunzip a file

validate.SmartComments

Validates the compiled lines

readRdHelp

Reads one or more Rd help files in a certain format

evaluate.Verbose

Evaluates a function and prints its results if above threshold

detachPackage

Detaches a packages by name

extract.array

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

sourceTo

Parses and evaluates code from a file or a connection

loadObject

Method to load object from a file or a connection

readTable

Reads a file in table format

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

isVisible.Verbose

Checks if a certain verbose level will be shown or not

getBuiltinTime.GString

Gets the current time

capitalize

Capitalizes/decapitalizes each character string in a vector

subplots

Creates a grid of subplots

isPackageInstalled

Checks if a package is installed or not

dataFrame

Allocates a data frame with given column classes

asLong.Java

Converts a numeric to a Java long

getAbsolutePath

Gets the absolute pathname string

getThreshold.Verbose

Gets current verbose threshold

SmartComments

Abstract class SmartComments

devSet

Activates a device

colClasses

Creates a vector of column classes used for tabular reading

VComments

The VComments class

dimNA< -

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

enter.Verbose

Writes a message and indents the following output

getBuiltinRversion.GString

Gets the current R version

R.utils-package

Package R.utils

isEof.connection

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

more.Verbose

Creates a cloned instance with a lower threshold

capture.Verbose

Captures output of a function

Options

The Options class

getBuiltinUsername.GString

Gets the username of the user running R

attachLocally.list

Assigns an objects elements locally

devIsOpen

Checks if a device is open or not

finalizeSession

Function to call for finalizing the R session

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

intToBin

Converts an integer to a binary/octal/hexadecimal number

getBuiltinRhome.GString

Gets the path where R is installed

seqToIntervals

Gets all contigous intervals of a vector of indices

insert

Insert values to a vector at certain positions

readBinFragments

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

getRegularExpression.Arguments

Gets a valid regular expression pattern

getHostname.System

Retrieves the computer name of the current host

getNumerics.Arguments

Coerces to a numeric vector and validates

flush.TextStatusBar

Flushes the output

toCamelCase

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

header.Verbose

Writes a header

print.Verbose

Prints objects if above threshold

newline.TextStatusBar

Writes a newline

readByte.Java

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

mkdirs

Creates a directory including any necessary but nonexistent parent directories

loadToEnv

Method to load objects to a new environment

getInstanceOf.Arguments

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

newline.Verbose

Writes one or several empty lines

setLabel.TextStatusBar

Sets the value of a label

sourceDirectory

Sources files recursively to either local or global environment

timestampOn.Verbose

Turns automatic timestamping on and off

saveObject

Saves an object to a file or a connection

getRaw.GString

Gets the unprocessed GString

remove.FileProgressBar

Removes the progress file for a file progress bar

reset.SmartComments

Resets a SmartComments compiler

moveInSearchPath

Moves a environment in the search path to another position

print.GString

Prints the processed GString

update.TextStatusBar

Updates the status bar (visually)

reassignInPackage

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

resetWarnings

Resets recorded warnings

Verbose

Class to writing verbose messages to a connection or file

splitByPattern

Splits a single character string by pattern

jpeg2

A JPEG device for Bitmap Files via GhostScript

update.ProgressBar

Updates progress bar

setTicks.ProgressBar

Sets values for which ticks should be visible

stext

Writes text in the margin along the sides of a plot

validate.VComments

Validates the compiled lines

writeRaw.NullVerbose

All output methods

getLogicals.Arguments

Coerces to a logical vector and validates

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

readInt.Java

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

setStepLength.ProgressBar

Sets default step length

setDefaultLevel.Verbose

Sets the current default verbose level

popMessage.TextStatusBar

Adds a message above the status bar

update.FileProgressBar

Updates file progress bar

off.Verbose

Turn off the output

loadAnywhere.Settings

Loads settings from file

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

isVector.Assert

Static method asserting thatan object is a vector

printf

C-style formatted output

relibrary

Reloads a package

getCharacters.Arguments

Coerces to a character vector and validates

readUTF.Java

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

setLabels.TextStatusBar

Sets new values of given labels

isAbsolutePath

Checks if this pathname is absolute

names.Options

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

getVariableValue.GString

Gets a variable value given a name and attributes

isOn.NullVerbose

Checks if the output is on

saveAnywhere.Settings

Saves settings to file

updateLabels.TextStatusBar

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

isDirectory

Checks if the file specification is a directory

parse.SmartComments

Parses one single smart comment

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

isFile

Checks if the file specification is a file

isOn.Verbose

Checks if the output is on

Creates a cloned instance with a higher threshold

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

onSessionExit

Registers a function to be called when the R session finishes

wrap.array

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

listDirectory

Gets the file names in the directory

writeRaw.MultiVerbose

Writes to each of the Verbose objects

readShort.Java

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

getRelativePath

Gets the relative pathname relative to a directory

setMaxValue.ProgressBar

Sets maximum value

setProgress.ProgressBar

Sets current progress

getBarString.ProgressBar

Gets the progress bar string to be displayed

compile.SmartComments

Preprocess a vector of code lines

str.Options

Prints the structure of the options

nbrOfOptions.Options

Gets the number of options set

patchCode

Patches installed and loaded packages and more

whichVector.logical

Identifies TRUE elements in a logical vector

isZero

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

setOption.Options

Sets an option

mapToIntervals.numeric

Maps values to intervals

warnings.Verbose

Outputs any warnings recorded

setValue.ProgressBar

Sets current value

pushState.Verbose

Pushes the current indentation state of the Verbose object

isPackageLoaded

Checks if a package is loaded or not

promptAndSave.Settings

Prompt user to save modified settings

writeInt.Java

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

mergeIntervals.numeric

Merges intervals

printf.Verbose

Formats and prints object if above threshold

setThreshold.Verbose

Sets verbose threshold

reset.ProgressBar

Reset progress bar

isOpen.character

Checks if there is an open connection to a file

readTableIndex

Reads a single column from file in table format

timestamp.Verbose

Writes a timestamp

getLabel.TextStatusBar

Gets the current value of a label

writeByte.Java

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

ProgressBar

Provides text based counting progress bar

setTimestampFormat.Verbose

Sets the default timestamp format

unwrap.array

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

touchFile

Updates the timestamp of a file

onGarbageCollect

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

isUrl

Checks if one or several pathnames is URLs

toUrl

Converts a pathname into a URL

as.character.Verbose

Returns a character string version of this object

getIntegers.Arguments

Coerces to a integer vector and validates

getOption.Options

Gets an option

getDoubles.Arguments

Coerces to a double vector and validates

getTimestampFormat.Verbose

Gets the default timestamp format

isMatrix.Assert

Static method asserting thatan object is a matrix

summary.Verbose

Generates a summary of an object if above threshold

writeBinFragments

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

FileProgressBar

A progress bar that sets the size of a file accordingly

asByte.Java

Converts a numeric to a Java byte

getBuiltinDatetime.GString

Gets the current date and time

displayCode

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

isDone.ProgressBar

Checks if progress bar is completed

removeDirectory

Removes a directory

findGraphicsDevice.System

Searches for a working PNG device

findSettings.Settings

Searches for the settings file in one or several directories

lastModified

Gets the time when the file was last modified

LComments

The LComments class

devList

Lists the indices of the open devices named by their labels

devOff

Closes a device

findSourceTraceback

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

getBuiltinOs.GString

Gets the operating system of the running machine

getBuiltinPid.GString

Gets the process id of the current R session

getParent

Gets the string of the parent specified by this pathname

getLeaves.Options

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

getWritablePathname.Arguments

Gets a writable pathname

inAnyInterval.numeric

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

getReadablePathnames.Arguments

Gets a readable pathname

seqToHumanReadable

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

str.Verbose

Prints the structure of an object if above threshold

writeRaw.Verbose

Writes objects if above threshold

writeUTF.Java

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

writeShort.Java

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