Learn R Programming

R.utils (version 2.13.0)

Various Programming Utilities

Description

Utility functions useful when programming and developing R packages.

Copy Link

Version

Install

install.packages('R.utils')

Monthly Downloads

181,629

Version

2.13.0

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/HenrikBengtsson/R.utils

Homepage

https://henrikbengtsson.github.io/R.utils/

Maintainer

Henrik Bengtsson

Last Published

February 24th, 2025

Functions in R.utils (2.13.0)

Undo changed done by this package when detached

The LComments class

Static class to validate and process arguments

A Verbose class ignoring everything

R.utils-package

Package R.utils

Abstract class SmartComments

Read File Symbolic Links (also on Windows)

Class for applicational settings

Class to writing verbose messages to a connection or file

as.double.Verbose

Gets a numeric value of this object

as.list.MultiVerbose

Gets a list of Verbose objects

Converts a numeric to a Java long

addFinalizerToLast

Modifies .Last() to call 'finalizeSession()

capture.Verbose

Captures output of a function

Converts a numeric to a Java short

The Assert class

Character string with advanced substitutions

Calls an R function passing command-line arguments

Static class for Java related methods

Evaluate an R expression and captures the output

Creates a vector of column classes used for tabular reading

downloadFile.character

Downloads a file

The Options class

Draws a density curve

Writes a message and unindents the following output

convertComment.SmartComments

Converts a single smart comment to R code

Provides text based counting progress bar

Compressing and decompressing files

convertComment.VComments

Converts a verbose comment to R code

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

as.character.GString

Gets the processed character string

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

Compresses a PDF (into a new PDF)

GString$getBuiltinOs

Gets the operating system of the running machine

GString$getBuiltinPid

Gets the process id of the current R session

System$currentTimeMillis

Get the current time in milliseconds

Executes a function call with option to ignore unused arguments

as.character.Options

Returns a character string version of this object

Allocates a data frame with given column classes

Gets a variable by name

Converts a binary/octal/hexadecimal number into a string

Global substitute of expression using regular expressions

callHooks.function

Call hook functions

Identifies and removes DLLs of packages already unloaded

Capitalizes/decapitalizes each character string in a vector

getMessage.TimeoutException

Gets the message of the exception

Arguments$getInstanceOf

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

FileProgressBar

A progress bar that sets the size of a file accordingly

Static class to query information about the system

Arguments$getIntegers

Coerces to a integer vector and validates

getTimestampFormat.Verbose

Gets the default timestamp format

System$getUsername

Retrieves the name of the user running R

inAnyInterval.numeric

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

Checks if this object is equal to another Options object

Checks if this object is equal to another

Concatenates and prints objects if above threshold

Arguments$getNumerics

Coerces to a numeric vector and validates

Parses, evaluates and outputs a GString

increase.ProgressBar

Increases (steps) progress bar

isOn.NullVerbose

Checks if the output is on

A status bar at the R prompt that can be updated

getRelativePath

Gets the relative pathname relative to a directory

as.character.ProgressBar

Gets a string description of the progress bar

Checks if the output is on

isOpen.character

Checks if there is an open connection to a file

as.character.Verbose

Returns a character string version of this object

getAbsolutePath

Gets the absolute pathname string

Static method asserting that a generic condition is true

Converts a numeric to a Java byte

Converts an numeric to a Java integer

getBarString.ProgressBar

Gets the progress bar string to be displayed

Copies a directory

isPackageInstalled

Checks if a package is installed or not

Extract command-line arguments

getThreshold.Verbose

Gets current verbose threshold

Concatenating vectors into human-readable strings

compile.SmartComments

Preprocess a vector of code lines

Convert byte sizes into human-readable byte sizes

Counts the number of lines in a text file

createFileAtomically

Creates a file atomically

mergeIntervals.numeric

Merges intervals

Detaches packages by name

intervalsToSeq.matrix

Generates a vector of indices from a matrix of intervals

GString$getBuiltinDate

Gets the current date

Creates a directory including any necessary but nonexistent parent directories

System$parseDebian

Parses a string, file or connection for Debian formatted parameters

Copies a file atomically

Checks if this pathname is absolute

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

Extract File Information (acknowledging symbolic file links also on Windows)

Checks the permission of a file or a directory

System$findGraphicsDevice

Searches for a working PNG device

isPackageLoaded

Checks if a package is loaded or not

Settings$findSettings

Searches for the settings file in one or several directories

Identifies all entries with replicated values

GString$getBuiltinRhome

Gets the path where R is installed

GString$getBuiltinRversion

Gets the current R version

getLabel.TextStatusBar

Gets the current value of a label

Arguments$getEnvironment

Gets an existing environment

Non-documented objects

Non-documented objects

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

Patches installed and loaded packages and more

finalizeSession

Function to call for finalizing the R session

newline.TextStatusBar

Writes a newline

promptAndSave.Settings

Prompt user to save modified settings

findSourceTraceback

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

Arguments$getFilename

Gets and validates a filename

getOption.Options

getLeaves.Options

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

flush.TextStatusBar

Flushes the output

newline.Verbose

Writes one or several empty lines

GString$getBuiltinTime

Gets the current time

A Verbose class ignoring everything

Appends a backup suffix to the pathname

GString$getBuiltinUsername

Gets the username of the user running R

Arguments$getReadablePathnames

Gets a readable pathname

TimeoutException

TimeoutException represents timeout errors

Arguments$getRegularExpression

Gets a valid regular expression pattern

GString$getVariableValue

Gets a variable value given a name and attributes

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

Arguments$getCharacters

Coerces to a character vector and validates

Sample values from a set of elements

reset.ProgressBar

Reset progress bar

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

Sets a option in R

Arguments$getDoubles

Coerces to a double vector and validates

Gets the string of the parent specified by this pathname

setMaxValue.ProgressBar

Sets maximum value

The VComments class

Parses and evaluates a GString into a regular string

as.list.Options

Gets a list representation of the options

as.logical.Verbose

Gets a logical value of this object

Arguments$getVector

Validates a vector

attachLocally.list

Assigns an objects elements locally

Gets the unprocessed GString

hasOption.Options

Checks if an option exists

setProgress.ProgressBar

Sets current progress

sourceDirectory

Sources files recursively to either local or global environment

Parses and evaluates code from a file or a connection

Call hook functions by hook name

setOption.Options

Arguments$getReadablePathname

Gets a readable pathname

Assert$inheritsFrom

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

installPackages

Install R packages by name or URL

Converts an integer to a binary/octal/hexadecimal number

Arguments$getVerbose

Coerces to Verbose object

Checks if the file specification is a directory

cleanup.FileProgressBar

Removes the progress file for a file progress bar

Updates the timestamp of a file

Insert values to a vector at certain positions

Arguments$getWritablePathname

Gets a writable pathname

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

mapToIntervals.numeric

Maps values to intervals

Checks if one or several pathnames has a URL protocol

Writes a header

setTicks.ProgressBar

Sets values for which ticks should be visible

Assert$isScalar

Static method asserting that an object is a single value

Identifies all entries that exists exactly once

Evaluate an R expression while temporarily diverting output

Creates a cloned instance with a higher threshold

Assert$isMatrix

Static method asserting that an object is a matrix

writeRaw.Verbose

Writes objects if above threshold

Simple access to parsed command-line arguments

Gets the file names in the directory

setTimestampFormat.Verbose

Sets the default timestamp format

isDone.ProgressBar

Checks if progress bar is completed

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

setStepLength.ProgressBar

Sets default step length

Creates a link to a file or a directory

isModified.Settings

Checks if settings has been modified compared to whats on file

Gets the time when the file was last modified

readBinFragments

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

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

Gets the pathname or a connection to the NULL device on the current platform

createWindowsShortcut

Creates a Microsoft Windows Shortcut (.lnk file)

Checks if one or several pathnames is URLs

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

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

Assert$isVector

Static method asserting that an object is a vector

Writes a message and indents the following output

Method to load objects to a new environment

Turn off the output

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

writeRaw.MultiVerbose

Writes to each of the Verbose objects

Gets a unique non-existing temporary variable name

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

evaluate.GString

Parses and evaluates a GString

evaluate.Verbose

Evaluates a function and prints its results if above threshold

Finds one or several files in multiple directories

System$findGhostscript

Searches for a Ghostview executable on the current system

reset.SmartComments

Resets a SmartComments compiler

GString$getBuiltinDatetime

Gets the current date and time

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

timestamp.Verbose

Writes a timestamp

Parses a GString

Creates a cloned instance with a lower threshold

setThreshold.Verbose

Sets verbose threshold

nbrOfOptions.Options

Gets the number of options set

Turn on the output

parse.SmartComments

Parses one single smart comment

Miscellaneous functions for outputting via message()

reset.VComments

Resets a VComments compiler

onGarbageCollect

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

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

Drops a backup suffix from the backup pathname

GString$getBuiltinHostname

Gets the hostname of the system running R

popMessage.TextStatusBar

Adds a message above the status bar

Open a file or URL using Windows File Associations

System$getHostname

Retrieves the computer name of the current host

pushState.Verbose

Pushes the current indentation state of the Verbose object

C-style formatted output

Formats and prints object if above threshold

Arguments$getIndices

Coerces to a integer vector and validates

popTemporaryFile

Drops a temporary suffix from the temporary pathname

pushTemporaryFile

Appends a temporary suffix to the pathname

Reads a file in table format

readWindowsShortcut

Reads a Microsoft Windows Shortcut (.lnk file)

writeRaw.NullVerbose

All output methods

readWindowsShellLink

Reads a Microsoft Windows Shortcut (.lnk file)

seqToHumanReadable

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

setDefaultLevel.Verbose

Sets the current default verbose level

Prints the processed GString

Attaches or loads packages

getLoadedPathname.Settings

Gets the pathname of the settings file loaded

setValue.ProgressBar

Sets current value

Arguments$getLogicals

Coerces to a logical vector and validates

Sets package repositories

updateLabels.TextStatusBar

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

Reads a single column from file in table format

isEof.connection

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

reassignInPackage

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

Swaps x and y coordinates of a density object

Reads one or more Rd help files in a certain format

Saves an object to a file or a connection

setLabel.TextStatusBar

Sets the value of a label

Checks if the file specification is a file

Registers a function to be called when the R session finishes

isVisible.NullVerbose

Checks if a certain verbose level will be shown or not

saveAnywhere.Settings

Saves settings to file

timestampOn.Verbose

Turns automatic timestamping on and off

update.ProgressBar

Updates progress bar

setLabels.TextStatusBar

Sets new values of given labels

validate.SmartComments

Validates the compiled lines

isVisible.Verbose

Checks if a certain verbose level will be shown or not

Launches another R process from within R

Evaluate an R expression with repositories set temporarily

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

Evaluate an R expression with a temporarily set random set

validate.VComments

Validates the compiled lines

Creates a grid of subplots

loadAnywhere.Settings

Loads settings from file

summary.Verbose

Generates a summary of an object if above threshold

whichVector.logical

Identifies TRUE elements in a logical vector

Java$writeShort

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

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

Method to load object from a file or a connection

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

Creates a temporary file with content

Converts a pathname into a URL

Evaluate an R expression with locale set temporarily

moveInSearchPath

Moves a environment in the search path to another position

A \"pager\" function that outputs to standard error

Gets all contiguous intervals of a vector of indices

writeBinFragments

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

update.FileProgressBar

Updates file progress bar

System$openBrowser

Opens an HTML document using the OS default HTML browser

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

Prints objects if above threshold

printWarnings.Verbose

Outputs any warnings recorded

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

removeDirectory

Removes a directory

Renames a file (or a directory) atomically/safely

Prints the structure of the options

update.TextStatusBar

Updates the status bar (visually)

Splits a single character string by pattern

Writes text in the margin along the sides of a plot

Prints the structure of an object if above threshold

Evaluate an R expression with options set temporarily

writeDataFrame.data.frame

Writes a data.frame to tabular text file