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

R.utils (version 1.5.7)

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

258,151

Version

1.5.7

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

November 12th, 2010

Functions in R.utils (1.5.7)

colClasses

Creates a vector of column classes used for tabular reading

mkdirs

Creates a directory including any necessary but nonexistent parent directories

setThreshold.Verbose

Sets verbose threshold

finalizeSession

Function to call for finalizing the R session

getVector.Arguments

Validates a vector

isFile

Checks if the file specification is a file

gzip

Gzip/Gunzip a file

as.character.Verbose

Returns a character string version of this object

ProgressBar

Provides text based counting progress bar

attachLocally.list

Assigns an objects elements locally

Arguments

Static class to validate and process arguments

System

Static class to query information about the system

NullVerbose

A Verbose class ignoring everything

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

as.list.Options

Gets a list representation of the options

callHooks.function

Call hook functions

asShort.Java

Converts a numeric to a Java short

as.character.Options

Returns a character string version of this object

nbrOfOptions.Options

Gets the number of options set

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

capitalize

Capitalizes/decapitalizes each character string in a vector

Verbose

Class to writing verbose messages to a connection or file

copyFile

Copies a file safely

devIsOpen

Checks if a device is open or not

getBuiltinHostname.GString

Gets the hostname of the system running R

getCharacters.Arguments

Coerces to a character vector and validates

SmartComments

Abstract class SmartComments

TextStatusBar

A status bar at the R prompt that can be updated

asByte.Java

Converts a numeric to a Java byte

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

as.double.Verbose

Gets a numeric value of this object

R.utils-package

Package R.utils

exit.Verbose

Writes a message and unindents the following output

currentTimeMillis.System

Get the current time in milliseconds

commandArgs

Extract Command Line Arguments

bunzip2

Bunzip a file

getRelativePath

Gets the relative pathname relative to a directory

getBarString.ProgressBar

Gets the progress bar string to be displayed

findSettings.Settings

Searches for the settings file in one or several directories

getUsername.System

Retrieves the name of the user running R

getHostname.System

Retrieves the computer name of the current host

isOn.NullVerbose

Checks if the output is on

equals.Options

Checks if this object is equal to another Options object

getInstanceOf.Arguments

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

insert

Insert values to a vector at certain positions

FileProgressBar

A progress bar that sets the size of a file accordingly

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

getLabel.TextStatusBar

Gets the current value of a label

GString

Character string with advanced substitutions

isPackageLoaded

Checks if a package is loaded or not

Assert

The Assert class

getLogicals.Arguments

Coerces to a logical vector and validates

isPackageInstalled

Checks if a package is installed or not

as.character.ProgressBar

Gets a string description of the progress bar

equals.Verbose

Checks if this object is equal to another

convertComment.SmartComments

Converts a single smart comment to R code

VComments

The VComments class

displayCode

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

Settings

Class for applicational settings

Gets the string of the parent specified by this pathname

copyDirectory

Copies a directory

moveInSearchPath

Moves a environment in the search path to another position

mapToIntervals.numeric

Maps values to intervals

getIntegers.Arguments

Coerces to a integer vector and validates

getNumerics.Arguments

Coerces to a numeric vector and validates

devSetLabel

Sets the label of a device

asLong.Java

Converts a numeric to a Java long

countLines

Counts the number of lines in a text file

readInt.Java

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

isScalar.Assert

Static method asserting thatan object is a single value

getDoubles.Arguments

Coerces to a double vector and validates

getBuiltinDate.GString

Gets the current date

callHooks

Call hook functions by hook name

dataFrame

Allocates a data frame with given column classes

evaluate.Verbose

Evaluates a function and prints its results if above threshold

getBuiltinUsername.GString

Gets the username of the user running R

Sys.setenv

getAbsolutePath

Gets the absolute pathname string

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

getTimestampFormat.Verbose

Gets the default timestamp format

as.logical.Verbose

Gets a logical value of this object

getLeaves.Options

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

isOn.Verbose

Checks if the output is on

as.character.GString

Gets the processed character string

getRegularExpression.Arguments

Gets a valid regular expression pattern

more.Verbose

Creates a cloned instance with a lower threshold

flush.TextStatusBar

Flushes the output

extract.array

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

findGhostscript.System

Searches for the ghostview binary on the current system

Options

The Options class

Java

Static class for Java related methods

printf

C-style formatted output

capture.Verbose

Captures output of a function

reset.VComments

Resets a VComments compiler

promptAndSave.Settings

Prompt user to save modified settings

devList

Lists the indices of the open devices named by their labels

check.Assert

Static method asserting that a generic condition is true

getReadablePathname.Arguments

Gets a readable pathname

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

setMaxValue.ProgressBar

Sets maximum value

loadAnywhere.Settings

Loads settings from file

asInt.Java

Converts an numeric to a Java integer

updateLabels.TextStatusBar

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

newline.Verbose

Writes one or several empty lines

seqToHumanReadable

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

getReadablePathnames.Arguments

Gets a readable pathname

dimNA< -

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

patchCode

Patches installed and loaded packages and more

isOpen.character

Checks if there is an open connection to a file

isModified.Settings

Checks if settings has been modified compared to whats on file

compile.SmartComments

Preprocess a vector of code lines

isZero

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

less.Verbose

Creates a cloned instance with a higher threshold

readTable

Reads a file in table format

devOff

Closes a device

summary.Verbose

Generates a summary of an object if above threshold

str.Verbose

Prints the structure of an object if above threshold

subplots

Creates a grid of subplots

whichVector.logical

Identifies TRUE elements in a logical vector

readUTF.Java

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

popMessage.TextStatusBar

Adds a message above the status bar

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

getBuiltinOs.GString

Gets the operating system of the running machine

on.Verbose

Turn on the output

findSourceTraceback

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

getBuiltinRhome.GString

Gets the path where R is installed

seqToIntervals

Gets all contigous intervals of a vector of indices

hasOption.Options

Checks if an option exists

isMatrix.Assert

Static method asserting thatan object is a matrix

loadToEnv

Method to load objects to a new environment

getVerbose.Arguments

Coerces to Verbose object

devDone

Closes an on-screen (interactive) device

update.FileProgressBar

Updates file progress bar

onGarbageCollect

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

stext

Writes text in the margin along the sides of a plot

getWritablePathname.Arguments

Gets a writable pathname

readBinFragments

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

isDirectory

Checks if the file specification is a directory

splitByPattern

Splits a single character string by pattern

wrap.array

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

enter.Verbose

Writes a message and indents the following output

isDone.ProgressBar

Checks if progress bar is completed

inherits.Assert

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

update.TextStatusBar

Updates the status bar (visually)

lapply.MultiVerbose

Applies a function to each of the Verbose objects

writeRaw.MultiVerbose

Writes to each of the Verbose objects

reset.SmartComments

Resets a SmartComments compiler

writeUTF.Java

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

setLabels.TextStatusBar

Sets new values of given labels

pushState.Verbose

Pushes the current indentation state of the Verbose object

touchFile

Updates the timestamp of a file

getEnvironment.Arguments

Gets an existing environment

update.ProgressBar

Updates progress bar

setStepLength.ProgressBar

Sets default step length

writeRaw.NullVerbose

All output methods

isUrl

Checks if one or several pathnames is URLs

saveObject

Saves an object to a file or a connection

isAbsolutePath

Checks if this pathname is absolute

sourceTo

Parses and evaluates code from a file or a connection

downloadFile.character

Downloads a file

validate.VComments

Validates the compiled lines

jpeg2

A JPEG device for Bitmap Files via GhostScript

setValue.ProgressBar

Sets current value

newline.TextStatusBar

Writes a newline

names.Options

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

writeByte.Java

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

off.Verbose

Turn off the output

detachPackage

Detaches a packages by name

unwrap.array

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

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

remove.FileProgressBar

Removes the progress file for a file progress bar

saveAnywhere.Settings

Saves settings to file

writeShort.Java

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

eps

EPS graphics device

resetWarnings

Resets recorded warnings

getBuiltinDatetime.GString

Gets the current date and time

parse.GString

Parses a GString

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

readRdHelp

Reads one or more Rd help files in a certain format

findGraphicsDevice.System

Searches for a working PNG device

setProgress.ProgressBar

Sets current progress

openBrowser.System

Opens an HTML document using the OS default HTML browser

sourceDirectory

Sources files recursively to either local or global environment

getBuiltinPid.GString

Gets the process id of the current R session

getBuiltinRversion.GString

Gets the current R version

setLabel.TextStatusBar

Sets the value of a label

writeBinFragments

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

Turns automatic timestamping on and off

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

doCall

Executes a function call with option to ignore unused arguments

toUrl

Converts a pathname into a URL

printf.Verbose

Formats and prints object if above threshold

writeRaw.Verbose

Writes objects if above threshold

loadObject

Method to load object from a file or a connection

setOption.Options

Sets an option

readShort.Java

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

parse.SmartComments

Parses one single smart comment

validate.SmartComments

Validates the compiled lines

listDirectory

Gets the file names in the directory

writeInt.Java

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

Non-documented objects

MultiVerbose

A Verbose class ignoring everything

cat.Verbose

Concatenates and prints objects if above threshold

print.GString

Prints the processed GString

convertComment.VComments

Converts a verbose comment to R code

fileAccess

Checks the permission of a file or a directory

getBuiltinTime.GString

Gets the current time

getRaw.GString

Gets the unprocessed GString

increase.ProgressBar

Increases (steps) progress bar

png2

A PNG device for Bitmap Files via GhostScript

print.Verbose

Prints objects if above threshold

str.Options

Prints the structure of the options

timestamp.Verbose

Writes a timestamp

warnings.Verbose

Outputs any warnings recorded

relibrary

Reloads a package

resample

Sample values from a set of elements

arrayIndex

Converts vector indices to array indices

devGetLabel

Gets the label of a device

getIndices.Arguments

Coerces to a integer vector and validates

getThreshold.Verbose

Gets current verbose threshold

lastModified

Gets the time when the file was last modified

readByte.Java

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

ruler.Verbose

Writes a ruler

setTicks.ProgressBar

Sets values for which ticks should be visible

isVector.Assert

Static method asserting thatan object is a vector

createLink

Creates a link to a file or a directory

devNew

Opens a new device

getVariableValue.GString

Gets a variable value given a name and attributes

intToBin

Converts an integer to a binary/octal/hexadecimal number

isEof.connection

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

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

mergeIntervals.numeric

Merges intervals

onSessionExit

Registers a function to be called when the R session finishes

setTimestampFormat.Verbose

Sets the default timestamp format

setDefaultLevel.Verbose

Sets the current default verbose level

reassignInPackage

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

readTableIndex

Reads a single column from file in table format

toCamelCase

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