Skip to content

Commit

Permalink
pkgdown tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikBengtsson committed Dec 13, 2023
1 parent 4dc05b9 commit 0f82b12
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@


<div id="badges"><!-- pkgdown markup -->
<a href="https://github.com/HenrikBengtsson/future.tools/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/HenrikBengtsson/future.tools/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a>
<a href="https://github.com/HenrikBengtsson/future.tools/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/HenrikBengtsson/future.tools/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a>
</div>

# future.tools: Tools for Working with Futures


## Installation

R package future.tools is only available via
[GitHub](https://github.com/HenrikBengtsson/future.tools) and can be
installed in R as:

R package future.tools is only available via [GitHub](https://github.com/HenrikBengtsson/future.tools) and can be installed in R as:
```r
remotes::install_github("HenrikBengtsson/future.tools")
remotes::install_github("HenrikBengtsson/future.tools", ref="master")
```


### Pre-release version

To install the pre-release version that is available in Git branch
`develop` on GitHub, use:

To install the pre-release version that is available in Git branch `develop` on GitHub, use:
```r
remotes::install_github("HenrikBengtsson/future.tools", ref="develop")
```

This will install the package from source.
This will install the package from source.

<!-- pkgdown-drop-below -->

4 changes: 3 additions & 1 deletion pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ navbar:
right: [futureverse, pkgs, cran, github]
components:
futureverse:
icon: fas fa-fast-backward
icon: fas fa-home
href: https://www.futureverse.org/
pkgs:
text: Packages
Expand Down Expand Up @@ -45,6 +45,8 @@ navbar:
href: https://BiocParallel.FutureParam.futureverse.org
- text: future.tools (experimental)
href: https://future.tools.futureverse.org
- text: future.mirai (experimental)
href: https://future.mirai.futureverse.org
- text: future.mapreduce (experimental)
href: https://future.mapreduce.futureverse.org
- text: marshal (experimental)
Expand Down
4 changes: 2 additions & 2 deletions pkgdown/_pkgdown.yml.rsp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<%
pkgs <- c("globals", "listenv", "parallelly", "future", "future.apply", "furrr", "future.tests", "future.callr", "future.batchtools", "doFuture", "progressr")
pkgs_extra <- c("BiocParallel.FutureParam", "future.tools", "future.mapreduce", "marshal")
pkgs_extra <- c("BiocParallel.FutureParam", "future.tools", "future.mirai", "future.mapreduce", "marshal")
pkgs <- c(sort(pkgs), pkgs_extra)
urls <- sprintf("https://%s.futureverse.org", pkgs)
names(urls) <- pkgs
Expand All @@ -27,7 +27,7 @@ navbar:
right: [futureverse, pkgs, cran, github]
components:
futureverse:
icon: fas fa-fast-backward
icon: fas fa-home
href: https://www.futureverse.org/
pkgs:
text: Packages
Expand Down

0 comments on commit 0f82b12

Please sign in to comment.