README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# envsetup <img src='man/figures/logo.png' align="right" height="200" style="float:right; height:200px;" />


<!-- badges: start -->

[<img src="http://pharmaverse.org/shields/envsetup.svg">](https://pharmaverse.org)
<!-- [![CRAN status](https://www.r-pkg.org/badges/version/envsetup)](https://CRAN.R-project.org/package=envsetup) -->
[![codecov](https://codecov.io/gh/pharmaverse/envsetup/branch/main/graph/badge.svg)](https://app.codecov.io/gh/pharmaverse/envsetup?branch=main)

<!-- badges: end -->

## Overview

The purpose of this package is to support the setup of the R environment.  The two main features are:


-   `autos` to automatically source files and/or directories into your environment

-   `paths` to consistently set path objects across projects for I/O

Both are implemented using a configuration file to allow easy, custom configurations that can be used for multiple or all projects.


## Installation

```{r eval = FALSE}
install.packages("envsetup")
```

### Development version

```{r eval = FALSE}
# install.packages("devtools")
devtools::install_github("pharmaverse/envsetup")
```


## Usage

1.  Create the _envsetup.yml configuration file to specify your autos and paths and store centrally. See `vignette("config")` for more details on how to create your config.
2.  Create or update your `.Rprofile` to read in the config and call `rprofile()`

```{r eval = FALSE}
library(envsetup)

# read configuration
envsetup_config <- config::get(file = "path/to/_envsetup.yml")

# pass configuration to rprofile() to setup the environment
rprofile(envsetup_config)
```