Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

path

Get a module’s path


Description

The following functions retrieve information about the path of the directory that a module or script is running in.

Usage

path(mod)

base_path(mod)

script_path()

knitr_path()

shiny_path()

testthat_path()

Arguments

mod

a module environment or namespace.

Details

script_path takes a best guess at a script’s path, since R does not provide a sure-fire way for determining the path of the currently executing code. The following calling situations are covered:

  1. Path explicitly set via set_script_path

  2. Path of a running document/application (knitr, Shiny)

  3. Path of unit test cases (testthat)

  4. Path of the currently opened source code file in RStudio

  5. Code invoked as Rscript script.r

  6. Code invoked as R CMD BATCH script.r

  7. Script run interactively (use getwd())

Value

path returns a character string containing the module’s full path.

base_path returns a character string containing the module’s base directory, or the current working directory if not invoked on a module.

script_path returns a character string that contains the directory in which the calling R code is run. See ‘Details’.

knitr_path returns the directory in which the currently knit document is run, or NULL if not called from within a knitr document.

shiny_path returns the directory in which a Shiny application is running, or NULL if not called from within a Shiny application.

testthat_path returns the directory in which testthat code is being executed, or NULL if not called from within a testthat test case.


box

Write Reusable, Composable and Modular R Code

v1.0.2
MIT + file LICENSE
Authors
Konrad Rudolph [aut, cre] (<https://orcid.org/0000-0002-9866-7051>), Michael Schubert [ctb] (<https://orcid.org/0000-0002-6862-5221>)
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.