this.path (version 1.2.0)

shFILE: Get Argument FILE Provided to R by a Shell

Description

Look through the command line arguments, extracting FILE from either of the following: -f FILE or --file=FILE

Usage

shFILE(original = FALSE, for.msg = FALSE, default, else.)

Value

character string, or default if the command line argument FILE

was not found.

Arguments

original

TRUE, FALSE, or NA; should the original or the normalized path be returned? NA means the normalized path will be returned if it has already been forced, and the original path otherwise.

for.msg

TRUE or FALSE; do you want the path for the purpose of printing a diagnostic message / / warning / / error? for.msg = TRUE will ignore original = FALSE, and will use original = NA instead.

default

if FILE is not found, this value is returned.

else.

missing or a function to apply if FILE is found. See tryCatch2 for inspiration.

See Also

this.path, here

Examples

FILE <- tempfile(fileext = ".R")
this.path:::write.code({
    withAutoprint({
        shFILE(original = TRUE)
        shFILE()
        shFILE(default = {
            stop("since 'FILE' will be found, argument 'default' will not\n",
                " be evaluated, so this error will not be thrown! you can\n",
                " use this to your advantage in a similar manner, doing\n",
                " arbitrary things only if 'FILE' is not found")
        })
    }, spaced = TRUE, verbose = FALSE, width.cutoff = 60L)
}, FILE)
this.path:::.Rscript(c("--default-packages=this.path", "--vanilla", FILE))


for (expr in c("shFILE(original = TRUE)",
               "shFILE(original = TRUE, default = NULL)",
               "shFILE()",
               "shFILE(default = NULL)"))
{
    cat("\n\n")
    this.path:::.Rscript(c("--default-packages=this.path", "--vanilla", "-e", expr))
}
unlink(FILE)