From 48294f27d0bb09c31d2aa52d15e0c004b7b80363 Mon Sep 17 00:00:00 2001 From: "mike.stackhouse" Date: Tue, 4 Jun 2024 16:11:06 +0000 Subject: [PATCH] Rebuild README --- README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 37250d2..5bb25c8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # envsetup @@ -5,9 +6,7 @@ [](https://pharmaverse.org) - - [![codecov](https://codecov.io/gh/pharmaverse/envsetup/branch/main/graph/badge.svg)](https://app.codecov.io/gh/pharmaverse/envsetup?branch=main) @@ -17,38 +16,36 @@ 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 +- `autos` to automatically source files and/or directories into your environment -* `paths` to consistently set path objects across projects for I/O +- `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 install.packages("envsetup") ``` ### Development version -``` +``` r # 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()` - - +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 library(envsetup) # read configuration