Skip to content

Commit

Permalink
Refresh documentation after move to the 'futureverse' GitHub organiza…
Browse files Browse the repository at this point in the history
…tion
  • Loading branch information
HenrikBengtsson committed Feb 7, 2025
1 parent f9c4e9f commit 4411f3d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 33 deletions.
10 changes: 2 additions & 8 deletions .make/README.md.rsp
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,8 @@ appveyor <- function(text = FALSE) {

covr <- function() {
bfr <- NULL
files <- c("covr.yaml", "R-CMD-check.yaml")
for (file in file.path(".github/workflows", files)) {
if (file.exists(file)) {
bfr <- readLines(file)
break
}
}
if (!any(grepl("covr::codecov", bfr, fixed=TRUE))) return()
files <- c("test-coverage.yaml", "covr.yaml")
if (!any(file_test("-f", file.path(".github/workflows/", files)))) return()
a("https://app.codecov.io/gh/%s", github_repos(), body=img("https://codecov.io/gh/%s/branch/develop/graph/badge.svg", github_repos(), alt="Coverage Status"))
}
%>
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

# Contributing to the 'future.mirai' package

This Git repository uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model (the [`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension is useful for this). The [`develop`](https://github.com/HenrikBengtsson/future.mirai/tree/develop) branch contains the latest contributions and other code that will appear in the next release, and the [`master`](https://github.com/HenrikBengtsson/future.mirai) branch contains the code of the latest release.
This Git repository uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model (the [`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension is useful for this). The [`develop`](https://github.com/futureverse/future.mirai/tree/develop) branch contains the latest contributions and other code that will appear in the next release, and the [`master`](https://github.com/futureverse/future.mirai) branch contains the code of the latest release, which is exactly what is currently on [CRAN](https://cran.r-project.org/package=future.mirai).

Contributing to this package is easy. Just send a [pull request](https://help.github.com/articles/using-pull-requests/). When you send your PR, make sure `develop` is the destination branch on the [future.mirai repository](https://github.com/HenrikBengtsson/future.mirai). Your PR should pass `R CMD check --as-cran`, which will also be checked by <a href="https://github.com/HenrikBengtsson/future.mirai/actions?query=workflow%3AR-CMD-check">GitHub Actions</a> and when the PR is submitted.
Contributing to this package is easy. Just send a [pull request](https://help.github.com/articles/using-pull-requests/). When you send your PR, make sure `develop` is the destination branch on the [future.mirai repository](https://github.com/futureverse/future.mirai). Your PR should pass `R CMD check --as-cran`, which will also be checked by <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3AR-CMD-check">GitHub Actions</a> and when the PR is submitted.

We abide to the [Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) of Contributor Covenant.
38 changes: 16 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@


<div id="badges"><!-- pkgdown markup -->
<a href="https://CRAN.R-project.org/web/checks/check_results_future.mirai.html"><img b
order="0" src="https://www.r-pkg.org/badges/version/future.mirai" alt="CRAN check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3Afuture_tests"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/future_tests.yaml/badge.svg?branch=develop" alt="future.tests checks status"/></a> <a href="https://app.codecov.io/gh/futureverse/future.mirai"><img border="0" src="https://codecov.io/gh/futureverse/future.mirai/branch/develop/graph/badge.svg" alt="Coverage Status"/></a>
<a href="https://CRAN.R-project.org/web/checks/check_results_future.mirai.html"><img border="0" src="https://www.r-pkg.org/badges/version/future.mirai" alt="CRAN check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3Afuture_tests"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/future_tests.yaml/badge.svg?branch=develop" alt="future.tests checks status"/></a> <a href="https://app.codecov.io/gh/futureverse/future.mirai"><img border="0" src="https://codecov.io/gh/futureverse/future.mirai/branch/develop/graph/badge.svg" alt="Coverage Status"/></a>
</div>

# future.mirai: A Future API for Parallel Processing using 'mirai'
# future.mirai: A 'Future' API for Parallel Processing using 'mirai'

## Introduction

Expand Down Expand Up @@ -84,7 +85,7 @@ plan(mirai_multisession)
demo("mandelbrot", package = "future", ask = FALSE)
```

To use `mirai_cluster` futures, use:
and

```r
library(future.mirai)
Expand All @@ -95,34 +96,27 @@ demo("mandelbrot", package = "future", ask = FALSE)
```


## Installation

R package **future.mirai** is available on
[CRAN](https://cran.r-project.org/package=future.mirai) and can be
installed in R as:
[mirai]: https://cran.r-project.org/package=mirai
[future]: https://cran.r-project.org/package=future
[future.mirai]: https://github.com/HenrikBengtsson/future.mirai
[future.apply]: https://cran.r-project.org/package=future.apply
[furrr]: https://cran.r-project.org/package=furrr
[doFuture]: https://cran.r-project.org/package=doFuture

## Installation
R package future.mirai is available on [CRAN](https://cran.r-project.org/package=future.mirai) and can be installed in R as:
```r
install.packages("future.mirai")
```


### 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("futureverse/future.mirai", ref="develop")
```

This will install the package from source.


[mirai]: https://cran.r-project.org/package=mirai
[future]: https://cran.r-project.org/package=future
[future.mirai]: https://cran.r-project.org/package=future.mirai
[future.apply]: https://cran.r-project.org/package=future.apply
[furrr]: https://cran.r-project.org/package=furrr
[doFuture]: https://cran.r-project.org/package=doFuture
This will install the package from source.

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

2 changes: 1 addition & 1 deletion pkgdown/_pkgdown.yml.rsp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ home:
- text: The Futureverse Project
href: https://www.futureverse.org/
- text: Futureverse User Forum
href: https://github.com/HenrikBengtsson/future/discussions
href: https://github.com/futureverse/future/discussions

navbar:
structure:
Expand Down

0 comments on commit 4411f3d

Please sign in to comment.