| Title: | Checks for Various Computing Environments |
| Version: | 0.2.1 |
| Description: | A collection of lightweight functions that can be used to determine the computing environment in which your code is running. This includes operating systems, continuous integration (CI) environments, containers, and more. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/briandconnelly/ami,https://briandconnelly.github.io/ami/ |
| BugReports: | https://github.com/briandconnelly/ami/issues |
| Imports: | curl, glue, lifecycle, rlang, rstudioapi (≥ 0.17.0) |
| Suggests: | config, covr, testthat (≥ 3.0.0), withr |
| Config/testthat/edition: | 3 |
| Config/testthat/parallel: | true |
| Encoding: | UTF-8 |
| Language: | en-US |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2024-11-15 18:04:52 UTC; bconnelly |
| Author: | Brian Connelly [aut, cre, cph], Mark Padgham [ctb], Lluís Revilla Sancho [ctb] |
| Maintainer: | Brian Connelly <bdc@bconnelly.net> |
| Repository: | CRAN |
| Date/Publication: | 2024-11-15 18:20:01 UTC |
ami: Checks for Various Computing Environments
Description
A collection of lightweight functions that can be used to determine the computing environment in which your code is running. This includes operating systems, continuous integration (CI) environments, containers, and more.
Author(s)
Maintainer: Brian Connellybdc@bconnelly.net (ORCID) [copyright holder]
Other contributors:
Mark Padghammark.padgham@email.com (ORCID) [contributor]
Lluís Revilla Sancholluis.revilla@gmail.com (ORCID) [contributor]
See Also
Useful links:
Report bugs athttps://github.com/briandconnelly/ami/issues
Detect Bioconductor
Description
Detect Bioconductor
Usage
on_bioconductor()Value
A logical value
References
Check the Bioconductor Build System: https://github.com/Bioconductor/BBS/
Examples
on_bioconductor()Detect CRAN
Description
This function detects whether the current R environment is aCRAN machine or not. It returnsFALSE if theNOT_CRAN environmentvariable used in "github/r-lib" packages likedevtools andtestthat is set to "true". If that variable is not set, the functionexamines other environment variables typically set on CRAN machines, asdocumented in the issue on this packages' GitHub repository athttps://github.com/briandconnelly/ami/issues/14.
Usage
on_cran(cran_pattern = "_R_", n_cran_envvars = 5L)Arguments
cran_pattern | String to match against environment variables. |
n_cran_envvars | If at least this number of environment variables matchthe |
Value
A logical value
Examples
on_cran()withr::with_envvar( list("NOT_CRAN" = "false", "_R_1" = 1, "_R_2" = 2), on_cran(n_cran_envvars = 2L))Checks related to networking
Description
online() usescurl::has_internet to check whether themachine is connected to the internet
Usage
online()using_host(hostname)Arguments
hostname | String containing a hostname or hostnames to check |
Value
A logical value
Examples
online()using_host("somehost.fakedomain.com")Determine whether a given user account is being used
Description
Determine whether a given user account is being used
Usage
using_account(username)Arguments
username | Username to check for |
Value
A logical value
Examples
using_account("root")Detect whether running in a CI environment
Description
using_ci() reports whether a continuous integrationenvironment is being used.
using_appveyor() reports whether AppVeyor is being used
using_circle_ci() reports whether CircleCI is being used
using_codebuild() reports whether AWS CodeBuild is being used
using_github_actions() reports whether GitHub Actions is beingused
using_gitlab_ci() reports whether GitLab CI/CD is being used
using_jenkins() reports whether Jenkins is being used
using_travis_ci() reports whether Travis CI is being used
Usage
using_ci(service = NULL)using_appveyor()using_circle_ci()using_codebuild()using_github_actions()using_gitlab_ci()using_jenkins()using_travis_ci()Arguments
service | If provided, a particular CI service is checked. If not, thecommonly-used |
Value
A logical value
Examples
using_ci()using_appveyor()using_circle_ci()using_codebuild()using_github_actions()using_gitlab_ci()using_jenkins()using_travis_ci()Determine whether Conda environment is being used
Description
Determine whether Conda environment is being used
Usage
using_conda(env = NULL)Arguments
env | Optional environment name to compare against |
Value
A logical value
Examples
# Check if Conda is being used (regardless of environment name)using_conda()# Check if the 'dev' Conda environment is being usedusing_conda(env = "dev")Detect whether a configuration is currently active
Description
Environment-specific configuration values can be used to alter code'sbehavior in different environments. Theconfig package uses theR_CONFIG_ACTIVE environment variable to specify the active environment.IfR_CONFIG_ACTIVE is not set, the"default" configuration is used.
Usage
using_config(config)Arguments
config | Configuration name |
Value
A logical value
Examples
# See whether the default configuration is being usedusing_config("default")# See whether the "production" configuration is being usedusing_config("production")Detect container environments
Description
Detect container environments
Usage
using_container()using_docker_container()using_podman_container()using_kubernetes()Value
A logical value
Examples
using_container()using_docker_container()using_podman_container()using_kubernetes()Detect covr
Description
Detect covr
Usage
using_covr()Value
A logical value
Examples
using_covr()Processor Checks
Description
using_cpu() checks whether the machine uses the given typeof processor or not.
using_x86_cpu() checks whether the machine uses an x86processor
using_arm_cpu() checks whether the machine uses an ARM-basedprocessor
Usage
using_cpu(arch = c("arm", "x86"))using_x86_cpu()using_arm_cpu()Arguments
arch | CPU architecture name. Either |
Value
A logical value
Examples
using_arm_cpu()using_x86_cpu()using_arm_cpu()Detect Databricks Runtime Environment
Description
Detect Databricks Runtime Environment
Usage
using_databricks()Value
A logical value
Examples
using_databricks()Determine whether an environment variable is being used
Description
Determine whether an environment variable is being used
Usage
using_envvar(x, value = NULL)Arguments
x | Environment variable |
value | Optional value to compare against |
Value
A logical value
Examples
using_envvar("NOT_CRAN")using_envvar("CI", "true")DetectNix Shell
Description
using_nix_shell() checks whether code is running within anenvironment defined by aNix expression.
Usage
using_nix_shell(pure = NULL)Arguments
pure | Whether or not the environment is pure, meaning most environmentvariables have been cleared before the shell started. |
Value
A logical value
Examples
# Check for Nixusing_nix_shell()# Check for Nix in a pure environmentusing_nix_shell(pure = TRUE)Determine whether a global option is being used
Description
Determine whether a global option is being used
Usage
using_option(x, value = NULL)Arguments
x | Option name |
value | Optional value to compare against |
Value
A logical value
Examples
using_option("width")using_option("boot.parallel", value = "multicore")Tests for operating systems
Description
Tests for operating systems
Usage
using_os(os = c("linux", "macos", "solaris", "windows"))using_linux()using_macos()using_solaris()using_windows()Arguments
os | Operating system name. One of |
Value
A logical value
Examples
using_os(os = "linux")using_linux()using_macos()using_solaris()using_windows()Positron environments
Description
These functions enable you to determine whether code is being run in thepresence of various features of thePositron IDE
using_positron() determines whether code is being run in Positron.using_positron_desktop(),using_positron_server() are helpers todetermine whether those specificenvironments are being used.
Usage
using_positron(mode = "any")using_positron_desktop()using_positron_server()Arguments
mode | Optional argument specifying whether Positron is being used in |
Value
A logical value
Examples
using_rstudio()Determine whether a Python virtual environment is being used
Description
Determine whether a Python virtual environment is being used
Usage
using_python_venv(env = NULL)Arguments
env | Optional environment name to compare against |
Value
A logical value
Examples
# Check if a Python virtual environment is being usedusing_python_venv()# Check if the 'dev' virtual environment is being usedusing_python_venv(env = "dev")Quarto documents
Description
using_quarto() determines whether code is being run within a Quartodocument
Usage
using_quarto()Value
A logical value
Note
Theis_using_quarto() function in thequartopackage can be used to determine whether your are in a quarto project.
Examples
using_quarto()R session information
Description
Get information about the R environment being used.
using_r_version() determines whether or not a particular version of R isbeing used.
using_latest_r_version() determines whether or not the latest stableversion of R is being used.
using_interactive_session() determines whether or not R isbeing run interactively.
Usage
using_r_version(ver)using_latest_r_version()using_interactive_session()Arguments
ver | Version string |
Value
A logical value
Examples
using_r_version(ver = "4.3.0")using_latest_r_version()using_interactive_session()RStudio environments
Description
These functions enable you to determine whether code is being run in thepresence of various features of the RStudio IDE and other Posit products.
using_rstudio() determines whether code is being run in RStudio.using_rstudio_desktop(),using_rstudio_server(), andusing_rstudio_workbench() are helpers to determine whether those specificenvironments are being used.
using_rstudio_jobs() determines whether code is running asanRStudio Job
using_rstudio_dark_theme() determines whether a dark theme isbeing used
using_posit_connect() checks whetherPosit Connectis being used
Usage
using_rstudio(mode = "any")using_rstudio_desktop()using_rstudio_server()using_rstudio_workbench()using_rstudio_jobs()using_rstudio_dark_theme()using_posit_connect()Arguments
mode | Optional argument specifying whether RStudio is being used in |
Value
A logical value
See Also
https://docs.posit.co/connect/user/content-settings/#content-vars
Examples
using_rstudio()using_rstudio_jobs()using_rstudio_dark_theme()using_posit_connect()Detect testthat
Description
Detect testthat
Usage
using_testthat()Value
A logical value
Examples
using_testthat()Detect whether code is running in Visual Studio Code
Description
Detect whether code is running in Visual Studio Code
Usage
using_vscode()Value
A logical value
Examples
using_vscode()