The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

envsetup

Check 🛠 Docs 📚 Code Coverage 📔 GitHub commit activity GitHub contributors GitHub last commit GitHub pull requests GitHub repo size Project Status: Active – The project has reached a stable, usable state and is being actively developed. Current Version Open Issues GitHub forks GitHub repo stars

Overview

The envsetup package helps you manage R project environments by providing a flexible configuration system that adapts to different deployment stages (development, testing, production) without requiring code changes.

Why Use envsetup?

When working on R projects, you often need to:

Instead of hardcoding paths or manually changing configurations, envsetup uses YAML configuration files to manage these differences automatically.

Basic Concepts

The envsetup package works with two main components:

  1. PATHS: Manages file system locations (data, output, programs)
  2. AUTOS: Automatically sources R scripts from specified directories

Your First Configuration

Here’s the simplest possible _envsetup.yml configuration:

default:
  paths:
    data: "/path/to/your/data"
    output: "/path/to/your/output"

Quick Start Example

library(envsetup)

# Load your configuration
envsetup_config <- config::get(file = "_envsetup.yml")

# Apply the configuration
rprofile(envsetup_config)

# Now you can use the configured paths
print(data)    # Points to your data directory
print(output)  # Points to your output directory

Installation

install.packages("envsetup")

Development version

# install.packages("devtools")
devtools::install_github("pharmaverse/envsetup")

What’s Next?

In the following guides, you’ll learn:

Let’s start with basic path configuration in the next section.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.