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

R.utils (version 0.9.5)

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

227,712

Version

0.9.5

License

LGPL version 2.1 or newer (the releases)

Maintainer

Henrik Bengtsson

Last Published

February 24th, 2025

Functions in R.utils (0.9.5)

getIndices.Arguments

Coerces to a integer vector and validates

System

Static class to query information about the system

finalizeSession

Function to call for finalizing the R session

as.character.ProgressBar

Gets a string description of the progress bar

FileProgressBar

A progress bar that sets the size of a file accordingly

getBuiltinUsername.GString

Gets the username of the user running R

getTimestampFormat.Verbose

Gets the default timestamp format

getBarString.ProgressBar

Gets the progress bar string to be displayed

as.double.Verbose

Gets a numeric value of this object

Java

Static class for Java related methods

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

GString

Character string with advanced substitutions

Sys.setenv

SmartComments

Abstract class SmartComments

eps

EPS graphics device

asByte.Java

Converts a numeric to a Java byte

ProgressBar

Provides text based counting progress bar

filePath

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

getIntegers.Arguments

Coerces to a integer vector and validates

detachPackage

Detaches a packages by name

print.GString

Prints the processed GString

isAbsolutePath

Checks if this pathname is absolute

hasUrlProtocol

Checks if one or several pathnames has a URL protocol

Extract Command Line Arguments

getRelativePath

Gets the relative pathname relative to a directory

displayCode

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

insert

Insert values to a vector at certain positions

pushState.Verbose

Pushes the current indentation state of the Verbose object

isDone.ProgressBar

Checks if progress bar is completed

capitalize

Capitalizes/decapitalizes each character string in a vector

setTimestampFormat.Verbose

Sets the default timestamp format

writeRaw.MultiVerbose

Writes to each of the Verbose objects

asInt.Java

Converts an numeric to a Java integer

getLeaves.Options

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

isOpen.character

Checks if there is an open connection in Rto a file

enter.Verbose

Writes a message and indents the following output

getLogicals.Arguments

Coerces to a logical vector and validates

callHooks

Call hook functions by hook name

names.Options

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

asLong.Java

Converts a numeric to a Java long

R.utils-package

Package R.utils

getEnvironment.Arguments

Gets an existing environment

newline.TextStatusBar

Writes a newline

getBuiltinHostname.GString

Gets the hostname of the system running R

reset.SmartComments

Resets a SmartComments compiler

readTableIndex

Reads a single column from file in table format

warnings.Verbose

Outputs any warnings recorded

saveAnywhere.Settings

Saves settings to file

getOption.Options

Gets an option

setTicks.ProgressBar

Sets values for which ticks should be visible

isFile

Checks if the file specification is a file

setMaxValue.ProgressBar

Sets maximum value

isVisible.Verbose

Checks if a certain verbose level will be shown or not

updateLabels.TextStatusBar

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

getParent

Gets the string of the parent specified by this pathname

readShort.Java

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

toCamelCase

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

findGraphicsDevice.System

Searches for a working PNG device

update.ProgressBar

Updates progress bar

isScalar.Assert

Static method asserting thatan object is a single value

getHostname.System

Retrieves the computer name of the current host

getThreshold.Verbose

Gets current verbose threshold

isUrl

Checks if one or several pathnames is URLs

setLabels.TextStatusBar

Sets new values of given labels

writeUTF.Java

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

as.character.Options

Returns a character string version of this object

extract.array

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

getNumerics.Arguments

Coerces to a numeric vector and validates

loadAnywhere.Settings

Loads settings from file

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

MultiVerbose

A Verbose class ignoring everything

newline.Verbose

Writes one or several empty lines

capture.Verbose

Captures output of a function

isModified.Settings

Checks if settings has been modified compared to whats on file

attachLocally.list

Assigns an objects elements locally

getBuiltinDatetime.GString

Gets the current date and time

getBuiltinOs.GString

Gets the operating system of the running machine

Arguments

Static class to validate and process arguments

print.Verbose

Prints objects if above threshold

Non-documented objects

setValue.ProgressBar

Sets current value

Settings

Class for applicational settings

jpeg2

A JPEG device for Bitmap Files via GhostScript

setProgress.ProgressBar

Sets current progress

exit.Verbose

Writes a message and unindents the following output

header.Verbose

Writes a header

getReadablePathnames.Arguments

Gets a readable pathname

getDoubles.Arguments

Coerces to a double vector and validates

cat.Verbose

Concatenates and prints objects if above threshold

increase.ProgressBar

Increases (steps) progress bar

getVariableValue.GString

Gets a variable value given a name and attributes

gunzip

Gunzip a file

summary.Verbose

Generates a summary of an object if above threshold

TextStatusBar

A status bar at the R prompt that can be updated

lapply.MultiVerbose

Applies a function to each of the Verbose objects

reset.VComments

Resets a VComments compiler

Gets the unprocessed GString

getUsername.System

Retrieves the name of the user running R

seqToIntervals

Gets all contigous intervals of a vector of indices

getBuiltinPid.GString

Gets the process id of the current R session

VComments

The VComments class

check.Assert

Static method asserting that a generic condition is true

isMatrix.Assert

Static method asserting thatan object is a matrix

setStepLength.ProgressBar

Sets default step length

update.FileProgressBar

Updates file progress bar

isVector.Assert

Static method asserting thatan object is a vector

mkdirs

Creates a directory including any necessary but nonexistent parent directories

listDirectory

Gets the file names in the directory

hasOption.Options

Checks if an option exists

more.Verbose

Creates a cloned instance with a lower threshold

doCall

Executes a function call with option to ignore unused arguments

moveInSearchPath

Moves a environment in the search path to another position

remove.FileProgressBar

Removes the progress file for a file progress bar

on.Verbose

Turn on the output

png2

A PNG device for Bitmap Files via GhostScript

less.Verbose

Creates a cloned instance with a higher threshold

popMessage.TextStatusBar

Adds a message above the status bar

writeRaw.NullVerbose

All output methods

seqToHumanReadable

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

promptAndSave.Settings

Prompt user to save modified settings

onSessionExit

Registers a function to be called when the R session finishes

parseDebian.System

Parses a string, file or connection for Debian formatted parameters

readTable

Reads a file in table format

patchCode

Patches installed and loaded packages and more

findGhostscript.System

Searches for the ghostview binary on the current system

off.Verbose

Turn off the output

splitByPattern

Splits a single character string by pattern

setLabel.TextStatusBar

Sets the value of a label

loadToEnv

Method to load objects to a new environment

validate.VComments

Validates the compiled lines

ruler.Verbose

Writes a ruler

setDefaultLevel.Verbose

Sets the current default verbose level

validate.SmartComments

Validates the compiled lines

unwrap.array

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

writeByte.Java

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

str.Options

Prints the structure of the options

getAbsolutePath

Gets the absolute pathname string

writeShort.Java

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

readByte.Java

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

setThreshold.Verbose

Sets verbose threshold

timestamp.Verbose

Writes a timestamp

as.character.GString

Gets the processed character string

arrayIndex

Converts vector indices to array indices

sourceDirectory

Sources files recursively to either local or global environment

equals.Verbose

Checks if this object is equal to another

getVerbose.Arguments

Coerces to Verbose object

resetWarnings

Resets recorded warnings

loadObject

Method to load object from a file or a connection

asShort.Java

Converts a numeric to a Java short

readUTF.Java

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

as.list.Options

Gets a list representation of the options

getBuiltinRversion.GString

Gets the current R version

getReadablePathname.Arguments

Gets a readable pathname

parse.SmartComments

Parses one single smart comment

lastModified

Gets the time when the file was last modified

getWritablePathname.Arguments

Gets a writable pathname

timestampOn.Verbose

Turns automatic timestamping on and off

wrap.array

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

isOn.Verbose

Checks if the output is on

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

readInt.Java

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

isDirectory

Checks if the file specification is a directory

relibrary

Reloads a package

isOn.NullVerbose

Checks if the output is on

str.Verbose

Prints the structure of an object if above threshold

writeRaw.Verbose

Writes objects if above threshold

nbrOfOptions.Options

Gets the number of options set

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

as.logical.Verbose

Gets a logical value of this object

Verbose

Class to writing verbose messages to a connection or file

NullVerbose

A Verbose class ignoring everything

currentTimeMillis.System

Get the current time in milliseconds

findSettings.Settings

Searches for the settings file in one or several directories

as.character.Verbose

Returns a character string version of this object

callHooks.function

Call hook functions

isZero

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

getBuiltinDate.GString

Gets the current date

getLabel.TextStatusBar

Gets the current value of a label

inherits.Assert

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

convertComment.VComments

Converts a verbose comment to R code

evaluate.Verbose

Evaluates a function and prints its results if above threshold

convertComment.SmartComments

Converts a single smart comment to R code

getBuiltinRhome.GString

Gets the path where R is installed

getVector.Arguments

Validates a vector

writeInt.Java

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

equals.Options

Checks if this object is equal to another Options object

update.TextStatusBar

Updates the status bar (visually)

printf.Verbose

Formats and prints object if above threshold

openBrowser.System

Opens an HTML document using the OS default HTML browser

saveObject

Saves an object to a file or a connection

as.character.binmode

Converts a binary/octal/hexadecimal number into a string

compile.SmartComments

Preprocess a vector of code lines

getCharacters.Arguments

Coerces to a character vector and validates

getBuiltinTime.GString

Gets the current time

getRegularExpression.Arguments

Gets a valid regular expression pattern

intToBin

Converts an integer to a binary/octal/hexadecimal number

toUrl

Converts a pathname into a URL

sourceTo

Parses and evaluates code from a file or a connection