Skip to content

Commit

Permalink
Rebuild README
Browse files Browse the repository at this point in the history
  • Loading branch information
mstackhouse committed Jun 4, 2024
1 parent dc5a7ec commit 48294f2
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@

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

# 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 -->
Expand All @@ -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
Expand Down

0 comments on commit 48294f2

Please sign in to comment.