Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
chainsawriot committed Dec 21, 2023
1 parent b8cb4a5 commit f92c30a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
13 changes: 11 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ knitr::opts_chunk$set(
)
```

# rang <img src="man/figures/rang_logo.svg" align="right" height="200" />
# rang <img src="man/figures/rang_logo.png" align="right" width = "120" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/gesistsa/rang/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/gesistsa/rang/actions/workflows/R-CMD-check.yaml)
Expand Down Expand Up @@ -303,10 +303,19 @@ If you run the container using `apptainer exec` command, you will have to kill t
`rang` can still be used to recreate computational environments for R < 3.1.0. The Dockerfile generated is based on Debian Lenny (5.0) and the requested version of R is compiled from source. As of writing, this method works for R < 3.1.0 but not R < 1.3.1. The `image` parameter is ignored in this case.

```r
rang_rio <- resolve("rio", snapshot_date = "2013-08-28") ## R 3.0.1
rang_rio <- resolve("rio", snapshot_date = "2013-08-30") ## R 3.0.1
dockerize(rang_rio, output_dir = "~/old_renviron")
```

## `evercran` support (experimental)

`rang` supports [evercran](https://github.com/r-hub/evercran). As of writing, the support is still experimental (just like `evercran` itself). In the future, `evercran` will replace the Debian method.

```r
rang_rio <- resolve("rio", snapshot_date = "2013-08-30") ## R 3.0.1
dockerize(rang_rio, output_dir = "~/old_renviron", method = "evercran")
```

## Acknowledgment

The logo of rang is a remix of [this](https://commons.wikimedia.org/wiki/File:Flag_of_the_Canary_Islands.svg) public domain image. The two dogs should be *Presa Canario*, the native dog breed on the islands of Gran Canaria and Tenerife.
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

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

# rang <img src="man/figures/rang_logo.svg" align="right" height="200" />
# rang <img src="man/figures/rang_logo.png" align="right" width = "120" />

<!-- badges: start -->

Expand Down Expand Up @@ -342,10 +342,21 @@ method works for R \< 3.1.0 but not R \< 1.3.1. The `image` parameter is
ignored in this case.

``` r
rang_rio <- resolve("rio", snapshot_date = "2013-08-28") ## R 3.0.1
rang_rio <- resolve("rio", snapshot_date = "2013-08-30") ## R 3.0.1
dockerize(rang_rio, output_dir = "~/old_renviron")
```

## `evercran` support (experimental)

`rang` supports [evercran](https://github.com/r-hub/evercran). As of
writing, the support is still experimental (just like `evercran`
itself). In the future, `evercran` will replace the Debian method.

``` r
rang_rio <- resolve("rio", snapshot_date = "2013-08-30") ## R 3.0.1
dockerize(rang_rio, output_dir = "~/old_renviron", method = "evercran")
```

## Acknowledgment

The logo of rang is a remix of
Expand Down
Binary file added man/figures/rang_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f92c30a

Please sign in to comment.