Docstring Template

Description

A minimal docstring template

Usage

DOCSTRING_TEMPLATE

Format

A single string, i.e. a character vector of length 1.

Examples

cat(DOCSTRING_TEMPLATE)

Get Name of Calling Function

Description

Returns the name of a calling function as string, i.e. if function g calls function f and function f calls caller(2), then string "g" is returned.

Usage

caller(n = 1)

Arguments

Details

Be careful when using caller(n) as input to other functions. Due to R's non-standard-evaluation (NES) mechanism it is possible that the function is not executed directly by that function but instead passed on to other functions, i.e. the correct number of frames to go up cannot be predicted a priori. Solutions are to evaluate the function first, store the result in a variable and then pass the variable to the function or to just try out the required number of frames to go up in an interactive session. For further examples see section Examples.

Value

Name of the calling function

Examples

# Here we want to return a list of all variables created inside a function
f <- function(a = 1, b = 2) {
    x <- 3
    y <- 4
    return(locals(without = formalArgs(caller(4))))
    # We need to go 4 frames up, to catch the formalArgs of `f`, because the
    # `caller(4)` argument is not evaluated directly be `formalArgs`.
}
f() # returns either list(x = 3, y = 4) or list(y = 4, x = 3)

# The same result could have been achieved as follows
g <- function(a = 1, b = 2) {
    x <- 3
    y <- 4
    func <- caller(1)
    return(locals(without = c("func", formalArgs(func))))
}
g() # returns either list(x = 3, y = 4) or list(y = 4, x = 3)

Capture output from a command

Description

Like classic capture.output(), but with additional arguments collapse and trim.

Usage

capture.output2(..., collapse = "\n", trim = FALSE)

Arguments

Value

If collapse is TRUE or "\n", a character vector of length 1. Else, a character vector of length n, where n corresponds to the number of lines outputted by the expression passed to capture.output().

See Also

capture.output()

Examples

x <- capture.output2(str(list(a = 1, b = 2, c = 1:3)))
cat2(x)

Concatenate and Print

Description

Same as cat but with an additional argument end, which gets printed after all other elements. Inspired by pythons print command.

Warning: this function is deprecated and should no longer be used. The function is guaranteed to be available as part of the package until the end of 2023 but might removed at any time after 31.12.2023.

Usage

cat0(..., sep = "", end = "")

Arguments

Value

No return value, called for side effects

Examples

cat0("hello", "world") # prints "helloworld" (without newline)

Concatenate and Print

Description

Same as cat but with an additional argument end, which gets printed after all other elements. Inspired by pythons print command.

Warning: this function is deprecated and should no longer be used. The function is guaranteed to be available as part of the package until the end of 2023 but might removed at any time after 31.12.2023.

Usage

cat0n(..., sep = "", end = "\n")

Arguments

Value

No return value, called for side effects

Examples

cat0n("hello", "world") # prints "helloworld\n"

Concatenate and Print

Description

Same as base::cat() but with an additional argument end, which gets printed after all other elements. Inspired by pythons print command.

Usage

cat2(
  ...,
  sep = " ",
  end = "\n",
  file = "",
  append = FALSE,
  fill = FALSE,
  labels = NULL
)

Arguments

Value

No return value, called for side effects

See Also

base::cat()

Examples

x <- 1
cat("x:", x, "\n") # prints 'Number: 1 \n' (with a space between 1 and \n)
cat2("x:", x) # prints 'Number: 1\n'  (without space)

Format and Print

Description

Same as cat(sprintf(fmt, ...))

Usage

catf(fmt, ..., file = "", append = FALSE, fill = FALSE, labels = NULL)

Arguments

Value

No return value, called for side effects

Examples

catf("A%dB%sC", 2, "asdf") # prints "A2BasdfC"

Format and Print

Description

Same as cat2(sprintf(fmt, ...))

Warning: this function is deprecated and should no longer be used. The function is guaranteed to be available as part of the package until the end of 2023 but might removed at any time after 31.12.2023.

Usage

catfn(
  fmt,
  ...,
  end = "\n",
  file = "",
  sep = " ",
  fill = FALSE,
  labels = NULL,
  append = FALSE
)

Arguments

Value

No return value, called for side effects

Examples

catfn("A%dB%sC", 2, "asdf") # prints "A2BasdfC\n"

Concatenate and Print

Description

Same as cat but with an additional argument end, which gets printed after all other elements. Inspired by pythons print command.

Warning: this function is deprecated and should no longer be used. The function is guaranteed to be available as part of the package until the end of 2023 but might removed at any time after 31.12.2023.

Usage

catn(..., sep = " ", end = "\n")

Arguments

Value

No return value, called for side effects

Examples

catn("hello", "world") # prints "hello world\n"

Concatenate and Print

Description

Same as cat but with an additional argument end, which gets printed after all other elements. Inspired by pythons print command.

Warning: this function is deprecated and should no longer be used. The function is guaranteed to be available as part of the package until the end of 2023 but might removed at any time after 31.12.2023.

Usage

catnn(..., sep = "\n", end = "\n")

Arguments

Value

No return value, called for side effects

Examples

catnn("hello", "world") # prints "hello\nworld\n"

Concatenate and Print

Description

Same as cat but with an additional argument end, which gets printed after all other elements. Inspired by pythons print command.

Warning: this function is deprecated and should no longer be used. The function is guaranteed to be available as part of the package until the end of 2023 but might removed at any time after 31.12.2023.

Usage

catsn(..., sep = " ", end = "\n")

Arguments

Value

No return value, called for side effects

Examples

catsn("hello", "world") # prints "hello world\n"

Check Documented Functions in a Package

Description

Lists all documented functions in a package and checks their documentation elements for potential issues. The following checks are performed:

1. Title is present and doesn't start with regex "Function".

2. Description is present and doesn't start with "This function".

3. Value is present.

4. Example is present.

Usage

check_pkg_docs(pkg = NULL)

Arguments

Value

Returns a dataframe with columns title, description, value, examples and rows corresponding to the documented functions in the package. Each cell contains a string describing the check result for the corresponding documentation element of that function.

Examples

df <- check_pkg_docs("tools")
try(df <- check_pkg_docs())

Get Normalized Configuration Directory Path of a Program

Description

config_dir returns the absolute, normalized path to the configuration directory of a program/package/app based on an optional app-specific commandline argument, an optional app-specific environment variable and the XDG Base Directory Specification

Usage

config_dir(
  app_name,
  cl_arg = commandArgs()[grep("--config-dir", commandArgs()) + 1],
  env_var = Sys.getenv(toupper(paste0(app_name, "_config_dir()"))),
  create = FALSE,
  sep = "/"
)

Arguments

Details

The following algorithm is used to determine the location of the configuration directory for application ⁠$app_name⁠:

1. If parameter cl_arg is a non-empty string, return it

2. Else, if parameter env_var is a non-empty string, return it

3. Else, if environment variable (EV) XDG_CONFIG_HOME exists, return ⁠$XDG_CONFIG_HOME/$app_name⁠

4. Else, if EV HOME exists, return ⁠$HOME/.config/{app_name}⁠

5. Else, if EV USERPROFILE exists, return ⁠$USERPROFILE/.config/{app_name}⁠

6. Else, return ⁠$WD/.config/{app-name}⁠

where ⁠$WD⁠ equals the current working directory and the notation ⁠$VAR⁠ is used to specify the value of a parameter or environment variable VAR.

Value

Normalized path to the configuration directory of ⁠$app_name⁠.

See Also

data_dir(), config_file(), xdg_config_home()

Examples

config_dir("myApp")

Get Normalized Configuration File Path of a Program

Description

config_file returns the absolute, normalized path to the configuration file of a program/package/app based on an optional app-specific commandline argument, an optional app-specific environment variable and the XDG Base Directory Specification

Usage

config_file(
  app_name,
  file_name,
  cl_arg = commandArgs()[grep("--config-file", commandArgs()) + 1],
  env_var = "",
  sep = "/",
  copy_dir = norm_path(xdg_config_home(), app_name),
  fallback_path = NULL
)

Arguments

Details

The following algorithm is used to determine the location of ⁠$file_name⁠:

1. If ⁠$cl_arg⁠ is a non-empty string, return it

2. Else, if ⁠$env_var⁠ is a non-empty string, return it

3. Else, if ⁠$PWD/.config/$app_name⁠ exists, return it

4. Else, if ⁠$XDG_CONFIG_HOME/$app_name/$file_name⁠ exists, return it

5. Else, if ⁠$HOME/.config/$app_name/$file_name⁠ exists, return it

6. Else, if ⁠$USERPROFILE/.config/$app_name/$file_name⁠ exists, return it

7. Else, if ⁠$copy_dir⁠ is non-empty string and ⁠$fallback_path⁠ is a path to an existing file, then try to copy ⁠$fallback_path⁠ to copy_dir/⁠$file_name⁠ and return copy_dir/⁠$file_name⁠ (Note, that in case $copy_dir is a non-valid path, the function will throw an error.)

8. Else, return $fallback_path

Value

Normalized path to the configuration file of ⁠$app_name⁠.

See Also

config_dir(), xdg_config_home()

Examples

config_dir("myApp")

Return Corners of Matrix like Objects

Description

Similar to head() and tail(), but returns n rows/cols from each side of x (i.e. the corners of x).

Usage

corn(x, n = 2L)

Arguments

Value

x[c(1:n, N-n:N), c(1:n, N-n:N)]

Examples

corn(matrix(1:10000, 100))

Get Normalized Data Directory Path of a Program

Description

data_dir returns the absolute, normalized path to the data directory of a program/package/app based on an optional app-specific commandline argument, an optional app-specific environment variable and the XDG Base Directory Specification

Usage

data_dir(
  app_name,
  cl_arg = commandArgs()[grep("--data-dir", commandArgs()) + 1],
  env_var = Sys.getenv(toupper(paste0(app_name, "_DATA_DIR"))),
  create = FALSE,
  sep = "/"
)

Arguments

Details

The following algorithm is used to determine the location of the data directory for application ⁠$app_name⁠:

1. If parameter ⁠$cl_arg⁠ is a non-empty string, return cl_arg

2. Else, if parameter ⁠$env_var⁠ is a non-empty string, return ⁠$env_var⁠

3. Else, if environment variable (EV) ⁠$XDG_DATA_HOME⁠ exists, return ⁠$XDG_DATA_HOME/$app_name⁠

4. Else, if EV ⁠$HOME⁠ exists, return ⁠$HOME/.local/share/$app_name⁠

5. Else, if EV ⁠$USERPROFILE⁠ exists, return ⁠$USERPROFILE/.local/share/$app_name⁠

6. Else, return ⁠$WD/.local/share⁠

Value

Normalized path to the data directory of ⁠$app_name⁠.

See Also

config_dir(), xdg_data_home()

Examples

data_dir("myApp")

Return ASCII representation of an R object

Description

Like classic dput(), but instead of writing to stdout, the text representation is returned as string.

Usage

dput2(..., collapse = " ", trim = TRUE)

Arguments

Value

If collapse == '\n', a character vector of length 1. Else, a character vector of length n, where n corresponds to the number of lines outputted by classic dput().

See Also

dput()

Examples

# Classic dput prints directly to stdout
x <- iris[1, ]
dput(x)

# Traditional formatting using dput2
y <- dput2(x, collapse = "\n", trim = FALSE)
cat2(y)

# Single line formatting
z <- dput2(x)
cat2(z)

Foreground Color Codes

Description

Provides ANSI escape codes as a named list for changing terminal text colors and style resetting. These codes can modify the foreground color and reset styles to defaults (incl. background color and text formatting).

Usage

fg

Format

A named list of ANSI escape codes for text coloring and style resetting in the terminal. Includes colors: GREY, RED, GREEN, YELLOW, BLUE, PURPLE, CYAN, WHITE, and RESET for default style restoration.

Examples

cat(fg$RED, "This text will be red.", fg$RESET, "\n")
cat(fg$GREEN, "This text will be green.", fg$RESET, "\n")
cat(fg$RESET, "Text back to default.", "\n")

Find DESCRIPTION File

Description

Searches for a DESCRIPTION file starting from the current or specified directory and moving upwards through the directory hierarchy until the file is found or the root directory is reached.

Usage

find_description_file(start_dir = getwd())

Arguments

Value

The path to the DESCRIPTION file if found. If not found, the function stops with an error message.

Examples

# Start search from a specific directory
graphics_pkg_dir <- system.file(package = "graphics")
find_description_file(graphics_pkg_dir)

## Not run: 
# Below example will only work if executed from a package directory
find_description_file()

## End(Not run)

Get Function Environment as List

Description

Returns the function environment as list. Raises an error when called outside a function. By default, objects specified as arguments are removed from the environment.

Usage

function_locals(without = c(), strip_function_args = TRUE)

Arguments

Details

The order of the symbols in the returned list is arbitrary.

Value

The function environment as list

Examples

f <- function(a = 1, b = 2) {
    x <- 3
    y <- 4
    return(function_locals())
}
all.equal(setdiff(f(), list(x = 3, y = 4)), list())

Get docstring for a Function

Description

The roxygen2 package makes it possible to write documentation for R functions directly above the corresponding function. This function can be used to retrieve the full documentation string (docstring).

Usage

get_docstring(content, func, collapse = TRUE, template = DOCSTRING_TEMPLATE)

Arguments

Value

A character vector of length 1 containing either the docstring or the empty string (in case no documentation could be detected).

Examples

uri <- system.file("testfiles/funcs.R", package = "toscutil")
content <- readLines(uri)
func <- "f2"
get_docstring(content, func)
get_docstring(content, func, collapse = TRUE)

Get formals of a Function

Description

Returns the arguments of a function from a valid R file.

Usage

get_formals(uri, content, func)

Arguments

Value

A named character vector as returned by formals().

Examples

uri <- system.file("testfiles/funcs.R", package = "toscutil")
content <- readLines(uri)
func <- "f2"
if (requireNamespace("languageserver", quietly = TRUE)) {
    get_formals(uri, content, func)
}

Get Documented Functions in a Package

Description

Lists all documented functions in a package together with some of their documentation elements as raw text. Only works for installed packages.

Usage

get_pkg_docs(pkg = NULL, unload = TRUE, reload = TRUE)

Arguments

Value

Returns a dataframe with columns title, description, value, examples and rows corresponding to the documented functions in the package.

Examples

df <- get_pkg_docs("tools")
nchars <- as.data.frame(apply(df, 2, function(col) sapply(col, nchar)))
head(nchars)

Get File Directory

Description

Return full path to current file directory

Usage

getfd(
  on.error = stop("No file sourced. Maybe you're in an interactive shell?", call. =
    FALSE),
  winslash = "/"
)

Arguments

Value

Current file directory as string

Examples

getfd(on.error = getwd())
## Not run: 
getfd()

## End(Not run)

Get Project Directory

Description

Find the project root directory by traversing the current working directory filepath upwards until a given set of files is found.

Usage

getpd(root.files = c(".git", "DESCRIPTION", "NAMESPACE"))

Arguments

Value

getpd returns the absolute, normalized project root directory as string. The forward slash is used as path separator (independent of the OS).

Examples

local({
     base_pkg_root_dir <- system.file(package = "base")
     base_pkg_R_dir <- file.path(base_pkg_root_dir, "R")
     owd <- setwd(base_pkg_R_dir); on.exit(setwd(owd))
     getpd()
})

Return help for topic

Description

Returns the help text for the specified topic formatted either as plain text, html or latex.

Usage

help2(topic, format = "text", package = NULL)

Arguments

Value

The help text for the specified topic in the specified format as string.

Examples

htm <- help2("sum", "html")
txt <- help2(topic = "sum", format = "text")
cat2(txt)

Get USERPROFILE or HOME

Description

Returns normalized value of environment variable USERPROFILE, if defined, else value of HOME.

Usage

home(winslash = "/")

Arguments

Value

normalized value of environment variable USERPROFILE, if defined, else value of HOME.

Examples

home()

Shortcut for multiple if else statements

Description

ifthen(a, b, c, d, e, f, ...) == if (a) b else if (c) d else if (e) f

Usage

ifthen(...)

Arguments

Value

ifelse returns the first value for which the corresponding statement evaluates to TRUE

Examples

x <- 2
y <- 2
z <- 1
ifthen(x == 0, "foo", y == 0, "bar", z == 1, "this string gets returned")

Truth checking as in Python

Description

Returns TRUE if x is either FALSE, 0, NULL, NAand empty lists or an empty string. Inspired by python's bool.

Usage

is.none(x)

Arguments

Value

TRUE if x is FALSE, 0, NULL, NA, an empty list or an empty string. Else FALSE.

Examples

is.none(FALSE) # TRUE
is.none(0) # TRUE
is.none(1) # FALSE
is.none(NA) # TRUE
is.none(list()) # TRUE
is.none("") # TRUE
is.none(character()) # TRUE
is.none(numeric()) # TRUE
is.none(logical()) # TRUE

Get specified Environment as List

Description

Return all symbols in the specified environment as list.

Usage

locals(without = c(), env = parent.frame())

Arguments

Value

Specified environment as list (without the mentioned symbols).

Examples

f <- function() {
     x <- 1
     y <- 2
     z <- 3
     locals()
}
ret <- f()
stopifnot(identical(ret, list(z = 3, y = 2, x = 1)))

logf function

Description

Prints a formatted string with optional prefix and end string. The default prefix is a grey timestamp and the default end is a newline character, which is useful for logging messages. All defaults can be set globally using options(). For details see 'Examples'.

Usage

logf(
  fmt,
  ...,
  file = .Options$toscutil.logf.file %||% "",
  append = .Options$toscutil.logf.append %||% FALSE,
  prefix = .Options$toscutil.logf.prefix %||% function() now_ms(usetz = FALSE, color =
    fg$GREY),
  sep1 = .Options$toscutil.logf.sep1 %||% " ",
  sep2 = .Options$toscutil.logf.sep2 %||% "",
  end = .Options$toscutil.logf.end %||% "\n"
)

Arguments

Value

No return value. This function is called for its side effect of printing a message.

Examples

logf("Hello, %s!", "world")
logf("Goodbye", prefix = function() "", sep1 = "", end = "!\n")
local({
     opts <- options(toscutil.logf.prefix = function() "LOG:", toscutil.logf.end = "\n")
     on.exit(options(opts))
     logf("Hello, %s!", "world")
})

Create automatically named List

Description

Like normal list(), except that unnamed elements are automatically named according to their symbol

Usage

named(...)

Arguments

Value

Object of type list with names attribute set

See Also

list()

Examples

a <- 1:10
b <- "helloworld"
l1 <- list(a, b)
names(l1) <- c("a", "b")
l2 <- named(a, b)
stopifnot(identical(l1, l2))
l3 <- list(z = a, b = b)
l4 <- named(z = a, b)
stopifnot(identical(l3, l4))

Return Normalized Path

Description

Shortcut for normalizePath(file.path(...), winslash = sep, mustWork = FALSE)

Usage

norm_path(..., sep = "/")

Arguments

Value

Normalized path constructed from ...

Examples

norm_path("C:/Users/max", "a\\b", "c") # returns C:/Users/max/a/b/c
norm_path("a\\b", "c") # return <current-working-dir>/a/b/c

Get Current Date and Time as String

Description

Returns the current system time as a string in the format ⁠YYYY-MM-DD hh:mm:ss[.XX][ TZ]⁠. Square brackets indicate optional parts of the string, 'XX' stands for milliseconds and 'TZ' for 'Timezone'.

Usage

now(usetz = TRUE, color = NULL, digits.sec = 0)

now_ms(usetz = TRUE, color = NULL, digits.sec = 2)

Arguments

Value

For now, the current system time as a string in the format ⁠YYYY-MM-DD hh:mm:ss TZ⁠. For now_ms, the format is ⁠YYYY-MM-DD hh:mm:ss.XX TZ⁠, where XX represents milliseconds.

See Also

Sys.time(), format.POSIXct()

Examples

now()                   # "2021-11-27 19:19:31 CEST"
now_ms()                # "2022-06-30 07:14:26.82 CEST"
now(usetz = FALSE)      # "2022-06-30 07:14:26.82"
now(color = fg$GREY)    # "\033[1;30m2024-06-27 14:41:20 CEST\033[0m"

Return Default if None

Description

Like rlang::%||%() but also checks for empty lists and empty strings.

Usage

x %none% y

Arguments

Value

Returns y if is.none(x) else x

See Also

is.none()

Examples

FALSE %none% 2 # returns 2
0 %none% 2 # returns 2
NA %none% 2 # returns 2
list() %none% 2 # returns 2
"" %none% 2 # returns 2
1 %none% 2 # returns 1

Predict Method for Numeric Vectors

Description

Interprets the provided numeric vector as linear model and uses it to generate predictions. If an element of the numeric vector has the name "Intercept" this element is treated as the intercept of the linear model.

Usage

## S3 method for class 'numeric'
predict(object, newdata, ...)

Arguments

Value

Named numeric vector of predicted scores

Examples

X <- matrix(1:4, 2, 2, dimnames = list(c("s1", "s2"), c("a", "b")))
b <- c(Intercept = 3, a = 2, b = 1)
predict(b, X)

Read DESCRIPTION File into a List

Description

Reads the DESCRIPTION file of an R package and converts it into a list where each element corresponds to a field in the DESCRIPTION file.

Usage

read_description_file(p = NULL)

Arguments

Value

A list where each element is a field from the DESCRIPTION file.

Examples

# Read DECRIPTION file from a specific path
graphics_pkg_dir <- system.file(package = "graphics")
graphics_pkg_descfile <- find_description_file(graphics_pkg_dir)
desc_list <- read_description_file(graphics_pkg_descfile)
str(desc_list)

## Not run: 
# Below example will only work if executed from a package directory
read_description_file()

## End(Not run)

Remove all objects from global environment

Description

Same as rm(list=ls())

Usage

rm_all()

Value

No return value, called for side effects

Examples

## Not run: rm_all()

Split a docstring into a Head, Param and Tail Part

Description

Split a docstring into a head, param and tail part.

Usage

split_docstring(docstring)

Arguments

Value

List with 3 elements: head, param and tail.

Examples

uri <- system.file("testfiles/funcs.R", package = "toscutil")
func <- "f4"
content <- readLines(uri)
docstring <- get_docstring(content, func)
split_docstring(docstring)

Stub Function Arguments

Description

stub() assigns all arguments of a given function as symbols to the specified environment (usually the current environment)

Usage

stub(func, ..., envir = parent.frame())

Arguments

Details

Stub is thought to be used for interactive testing and unit testing. It does not work for primitive functions.

Value

list of symbols that are assigned to envir

Examples

f <- function(x, y = 2, z = 3) x + y + z
args <- stub(f, x = 1) # assigns x = 1, y = 2 and z = 3 to current env

Terminate a non-interactive R Session

Description

Similar to python's sys.exit. If used interactively, code execution is stopped with an error message, giving the provided status code. If used non-interactively (e.g. through Rscript), code execution is stopped silently and the process exits with the provided status code.

Usage

sys.exit(status = 0)

Arguments

Value

No return value, called for side effects

Examples

## Not run: 
if (!file.exists("some.file")) {
    cat("Error: some.file does not exist.\n", file = stderr())
    sys.exit(1)
} else if (Sys.getenv("IMPORTANT_ENV") == "") {
    cat("Error: IMPORTANT_ENV not set.\n", file = stderr())
    sys.exit(2)
} else {
    cat("Everything good. Starting calculations...")
    # ...
    cat("Finished with success!")
    sys.exit(0)
}

## End(Not run)

Traces function calls from a package

Description

Traces all function calls from a package and writes them to file with timestamps and callstack depth. Should always be used in combination with untrace_package() to untrace the package after use. For example ⁠trace_package("graphics"); on.exit(untrace_package("graphics")⁠. See examples for more details.

Usage

trace_package(
  pkg,
  file = stdout(),
  max = Inf,
  funign = character(),
  opsign = TRUE,
  dotign = TRUE,
  silent = TRUE,
  exitmsg = "exit"
)

Arguments

Details

Some function define their own on.exit() handlers with option add = FALSE. For those functions, exit tracing is impossible (as described in trace()). For now those functions have to be detected and ignored manually by the user using argument funign.

Value

No return value, called for side effects

See Also

untrace_package()

Examples

## Not run: 
# Trace all function from the graphics package, except for `plot.default`
# as it defines its own on.exit() handler, i.e. exit tracing is impossible.
local({
    trace_package("graphics", funign = "plot.default")
    on.exit(untrace_package("graphics"), add = TRUE)
    plot(1:10)
})

## End(Not run)

Untraces function calls from a package

Description

Removes tracing from all function calls in a package that were previously traced by trace_package().

Usage

untrace_package(pkg)

Arguments

Details

This function reverses the effects of trace_package by removing all tracing from the specified package's functions.

Value

No return value, called for side effects

See Also

trace_package()

Examples

## Not run: 
local({
    trace_package("graphics", funign = "plot.default")
    on.exit(untrace_package("graphics"), add = TRUE)
    plot(1:10)
})

## End(Not run)

Update docstring for a Function

Description

The roxygen2 package makes it possible to write documentation for R functions directly above the corresponding function. This function can be used to update the parameter list of a documentation string (docstring) of a valid function of a valid R file. The update is done by comparing the currently listed parameters with the actual function parameters. Outdated parameters are removed and missing parameters are added to the docstring.

Usage

update_docstring(uri, func, content = NULL)

Arguments

Value

A character vector of length 1 containing the updated docstring.

Examples

uri <- system.file("testfiles/funcs.R", package = "toscutil")
func <- "f4"
update_docstring(uri, func)

Get XDG_CONFIG_HOME

Description

Return value for XDG_CONFIG_HOME as defined by the XDG Base Directory Specification

Usage

xdg_config_home(sep = "/", fallback = normalizePath(getwd(), winslash = sep))

Arguments

Value

The following algorithm is used to determine the returned path:

1. If environment variable (EV) XDG_CONFIG_HOME exists, return its value

2. Else, if EV HOME exists, return ⁠$HOME/.config⁠

3. Else, if EV USERPROFILE exists, return ⁠$USERPROFILE/.config⁠

4. Else, return ⁠$fallback⁠

See Also

xdg_data_home()

Examples

xdg_config_home()

Get XDG_DATA_HOME

Description

Return value for XDG_DATA_HOME as defined by the XDG Base Directory Specification

Usage

xdg_data_home(sep = "/", fallback = normalizePath(getwd(), winslash = sep))

Arguments

Value

The following algorithm is used to determine the returned path:

1. If environment variable (EV) ⁠$XDG_DATA_HOME⁠ exists, return its value

2. Else, if EV ⁠$HOME⁠ exists, return ⁠$HOME/.local/share⁠

3. Else, if EV ⁠$USERPROFILE⁠ exists, return ⁠$USERPROFILE/.local/share⁠

4. Else, return ⁠$fallback⁠

See Also

xdg_config_home()

Examples

xdg_data_home()