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

R.utils (version 1.12.1)

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

191,979

Version

1.12.1

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

March 23rd, 2012

Functions in R.utils (1.12.1)

asByte.Java

Converts a numeric to a Java byte

asLong.Java

Converts a numeric to a Java long

getBuiltinTime.GString

Gets the current time

getCharacters.Arguments

Coerces to a character vector and validates

isOn.Verbose

Checks if the output is on

FileProgressBar

A progress bar that sets the size of a file accordingly

Arguments

Static class to validate and process arguments

Verbose

Class to writing verbose messages to a connection or file

draw.density

Draws a density curve

Settings

Class for applicational settings

as.character.GString

Gets the processed character string

newline.Verbose

Writes one or several empty lines

downloadFile.character

Downloads a file

as.logical.Verbose

Gets a logical value of this object

pushTemporaryFile

Appends a temporary suffix to the pathname

popMessage.TextStatusBar

Adds a message above the status bar

evalCapture

Evaluates an expression and captures the code and/or the output

evaluate.Verbose

Evaluates a function and prints its results if above threshold

readShort.Java

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

R.utils-package

Package R.utils

reset.VComments

Resets a VComments compiler

copyDirectory

Copies a directory

getBuiltinHostname.GString

Gets the hostname of the system running R

getBuiltinOs.GString

Gets the operating system of the running machine

getUsername.System

Retrieves the name of the user running R

NullVerbose

A Verbose class ignoring everything

Java

Static class for Java related methods

TextStatusBar

A status bar at the R prompt that can be updated

lapply.MultiVerbose

Applies a function to each of the Verbose objects

readByte.Java

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

extract.array

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

seqToIntervals

Gets all contigous intervals of a vector of indices

asInt.Java

Converts an numeric to a Java integer

Sys.setenv

LComments

The LComments class

as.character.ProgressBar

Gets a string description of the progress bar

getReadablePathname.Arguments

Gets a readable pathname

Options

The Options class

devEval

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

asShort.Java

Converts a numeric to a Java short

inherits.Assert

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

arrayIndex

Converts vector indices to array indices

bunzip2

Bunzip a file

isVector.Assert

Static method asserting thatan object is a vector

Moves a environment in the search path to another position

evalWithTimeout

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

currentTimeMillis.System

Get the current time in milliseconds

displayCode

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

getBuiltinDate.GString

Gets the current date

onGarbageCollect

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

Assert

The Assert class

png2

A PNG device for Bitmap Files via GhostScript

setProgress.ProgressBar

Sets current progress

SmartComments

Abstract class SmartComments

convertComment.VComments

Converts a verbose comment to R code

as.character.Verbose

Returns a character string version of this object

colClasses

Creates a vector of column classes used for tabular reading

fileAccess

Checks the permission of a file or a directory

Non-documented objects

capitalize

Capitalizes/decapitalizes each character string in a vector

subplots

Creates a grid of subplots

printf

C-style formatted output

dataFrame

Allocates a data frame with given column classes

dimNA< -

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

finalizeSession

Function to call for finalizing the R session

lastModified

Gets the time when the file was last modified

devList

Lists the indices of the open devices named by their labels

setLabel.TextStatusBar

Sets the value of a label

parse.SmartComments

Parses one single smart comment

MultiVerbose

A Verbose class ignoring everything

detachPackage

Detaches a packages by name

unwrap.array

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

validate.SmartComments

Validates the compiled lines

VComments

The VComments class

enter.Verbose

Writes a message and indents the following output

cat.Verbose

Concatenates and prints objects if above threshold

getIndices.Arguments

Coerces to a integer vector and validates

TimeoutException

TimeoutException represents timeout errors

getDoubles.Arguments

Coerces to a double vector and validates

eps

EPS graphics device

readTableIndex

Reads a single column from file in table format

ProgressBar

Provides text based counting progress bar

str.Options

Prints the structure of the options

filePath

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

cleanup.FileProgressBar

Removes the progress file for a file progress bar

timestampOn.Verbose

Turns automatic timestamping on and off

getVariableValue.GString

Gets a variable value given a name and attributes

print.Verbose

Prints objects if above threshold

devDone

Closes an open device unless it is a on-screen (interactive) device

splitByPattern

Splits a single character string by pattern

getEnvironment.Arguments

Gets an existing environment

toEPS

Methods for creating image files of a specific format

getBarString.ProgressBar

Gets the progress bar string to be displayed

exit.Verbose

Writes a message and unindents the following output

getHostname.System

Retrieves the computer name of the current host

capture.Verbose

Captures output of a function

getLogicals.Arguments

Coerces to a logical vector and validates

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

System

Static class to query information about the system

getMessage.TimeoutException

Gets the message of the exception

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

getBuiltinRhome.GString

Gets the path where R is installed

copyFile

Copies a file safely

isDirectory

Checks if the file specification is a directory

GString

Character string with advanced substitutions

isMatrix.Assert

Static method asserting thatan object is a matrix

pushState.Verbose

Pushes the current indentation state of the Verbose object

devIsOpen

Checks if a device is open or not

setTicks.ProgressBar

Sets values for which ticks should be visible

loadObject

Method to load object from a file or a connection

devGetLabel

Gets the label of a device

more.Verbose

Creates a cloned instance with a lower threshold

setLabels.TextStatusBar

Sets new values of given labels

getIntegers.Arguments

Coerces to a integer vector and validates

getAbsolutePath

Gets the absolute pathname string

writeByte.Java

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

insert

Insert values to a vector at certain positions

equals.Verbose

Checks if this object is equal to another

Assigns an objects elements locally

equals.Options

Checks if this object is equal to another Options object

printf.Verbose

Formats and prints object if above threshold

isOn.NullVerbose

Checks if the output is on

getVector.Arguments

Validates a vector

getThreshold.Verbose

Gets current verbose threshold

wrap.array

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

setThreshold.Verbose

Sets verbose threshold

isUrl

Checks if one or several pathnames is URLs

findSourceTraceback

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

isVisible.Verbose

Checks if a certain verbose level will be shown or not

intToBin

Converts an integer to a binary/octal/hexadecimal number

isReplicated

Identifies all entries with replicated values

getOption.Options

Gets an option

loadToEnv

Method to load objects to a new environment

getRelativePath

Gets the relative pathname relative to a directory

getTimestampFormat.Verbose

Gets the default timestamp format

getWritablePathname.Arguments

Gets a writable pathname

isScalar.Assert

Static method asserting thatan object is a single value

mergeIntervals.numeric

Checks if the file specification is a file

getRaw.GString

Gets the unprocessed GString

devSetLabel

Sets the label of a device

getVerbose.Arguments

Coerces to Verbose object

isPackageLoaded

Checks if a package is loaded or not

print.GString

Prints the processed GString

getReadablePathnames.Arguments

Gets a readable pathname

listDirectory

Gets the file names in the directory

hpaste

Concatenating vectors into human-readable strings

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

increase.ProgressBar

Increases (steps) progress bar

isOpen.character

Checks if there is an open connection to a file

isEof.connection

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

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

findSettings.Settings

Searches for the settings file in one or several directories

isModified.Settings

Checks if settings has been modified compared to whats on file

popBackupFile

Drops a backup suffix from the backup pathname

setOption

Sets a option in R

getLeaves.Options

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

isDone.ProgressBar

Checks if progress bar is completed

patchCode

Patches installed and loaded packages and more

isPackageInstalled

Checks if a package is installed or not

resample

Sample values from a set of elements

getParent

Gets the string of the parent specified by this pathname

promptAndSave.Settings

Prompt user to save modified settings

queryRCmdCheck

Gets the on R CMD check if the current R session was launched by it

setValue.ProgressBar

Sets current value

seqToHumanReadable

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

getRegularExpression.Arguments

Gets a valid regular expression pattern

setDefaultLevel.Verbose

Sets the current default verbose level

reset.SmartComments

Resets a SmartComments compiler

hasOption.Options

Checks if an option exists

validate.VComments

Validates the compiled lines

pushBackupFile

Appends a backup suffix to the pathname

readBinFragments

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

summary.Verbose

Generates a summary of an object if above threshold

setTimestampFormat.Verbose

Sets the default timestamp format

writeDataFrame.data.frame

Writes a data.frame to tabular text file

sourceDirectory

Sources files recursively to either local or global environment

touchFile

Updates the timestamp of a file

writeRaw.MultiVerbose

Writes to each of the Verbose objects

readUTF.Java

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

sourceTo

Parses and evaluates code from a file or a connection

popTemporaryFile

Drops a temporary suffix from the temporary pathname

saveObject

Saves an object to a file or a connection

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

onSessionExit

Registers a function to be called when the R session finishes

writeRaw.NullVerbose

All output methods

resetWarnings

Resets recorded warnings

names.Options

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

as.character.Options

Returns a character string version of this object

writeRaw.Verbose

Writes objects if above threshold

readRdHelp

Reads one or more Rd help files in a certain format

findGhostscript.System

Searches for the ghostview binary on the current system

less.Verbose

Creates a cloned instance with a higher threshold

setStepLength.ProgressBar

Sets default step length

mapToIntervals.numeric

Maps values to intervals

writeBinFragments

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

setMaxValue.ProgressBar

Sets maximum value

str.Verbose

Prints the structure of an object if above threshold

timestamp.Verbose

Writes a timestamp

readInt.Java

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

saveAnywhere.Settings

Saves settings to file

createLink

Creates a link to a file or a directory

flush.TextStatusBar

Flushes the output

updateLabels.TextStatusBar

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

writeShort.Java

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

toUrl

Converts a pathname into a URL

getBuiltinDatetime.GString

Gets the current date and time

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

getBuiltinRversion.GString

Gets the current R version

getInstanceOf.Arguments

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

callHooks

Call hook functions by hook name

check.Assert

Static method asserting that a generic condition is true

jpeg2

A JPEG device for Bitmap Files via GhostScript

commandArgs

Extract Command Line Arguments

getNumerics.Arguments

Coerces to a numeric vector and validates

update.TextStatusBar

Updates the status bar (visually)

off.Verbose

Turn off the output

env

Creates a new environment, evaluates an expression therein, and returns the environment

isAbsolutePath

Checks if this pathname is absolute

getBuiltinUsername.GString

Gets the username of the user running R

loadAnywhere.Settings

Loads settings from file

as.double.Verbose

Gets a numeric value of this object

isSingle

Identifies all entries that exists exactly ones

readTable

Reads a file in table format

devOptions

Gets the default device options

swapXY.density

Swaps x and y coordinates of a density object

getLabel.TextStatusBar

Gets the current value of a label

renameFile

Renames a file safely

update.FileProgressBar

Updates file progress bar

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

isZero

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

whichVector.logical

Identifies TRUE elements in a logical vector

writeInt.Java

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

mkdirs

Creates a directory including any necessary but nonexistent parent directories

writeUTF.Java

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

nbrOfOptions.Options

Gets the number of options set

openBrowser.System

Opens an HTML document using the OS default HTML browser

newline.TextStatusBar

Writes a newline

reassignInPackage

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

compile.SmartComments

Preprocess a vector of code lines

as.list.Options

Gets a list representation of the options

convertComment.SmartComments

Converts a single smart comment to R code

createFileAtomically

Creates a file atomically

getBuiltinPid.GString

Gets the process id of the current R session

findGraphicsDevice.System

Searches for a working PNG device

header.Verbose

Writes a header

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

warnings.Verbose

Outputs any warnings recorded

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

countLines

Counts the number of lines in a text file

callHooks.function

Call hook functions

doCall

Executes a function call with option to ignore unused arguments

inAnyInterval.numeric

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

Writes text in the margin along the sides of a plot

toCamelCase

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