Updated 'gh-pages' from docs/ folder

Author: HenrikBengtsson

404.html

@@ -0,0 +1,3 @@
+Content not found. Please use links in the navbar.
+
+# Page not found (404)

404.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our
+project and our community a harassment-free experience for everyone,
+regardless of age, body size, disability, ethnicity, gender identity and
+expression, level of experience, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual
+  attention or advances
+- Trolling, insulting/derogatory comments, and personal or political
+  attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or
+  electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of
+acceptable behavior and are expected to take appropriate and fair
+corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit,
+or reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that they
+deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public
+spaces when an individual is representing the project or its community.
+Examples of representing a project or community include using an
+official project e-mail address, posting via an official social media
+account, or acting as an appointed representative at an online or
+offline event. Representation of a project may be further defined and
+clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported by contacting the project team. All complaints will be
+reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in
+good faith may face temporary or permanent repercussions as determined
+by other members of the project’s leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.4, available at
+[http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/)

CONDUCT.html

@@ -0,0 +1,28 @@
+# Contributing to the ‘future.batchtools’ 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/futureverse/future.batchtools/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.batchtools) branch
+contains the code of the latest release, which is exactly what is
+currently on
+[CRAN](https://cran.r-project.org/package=future.batchtools).
+
+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.batchtools
+repository](https://github.com/futureverse/future.batchtools). Your PR
+should pass `R CMD check --as-cran`, which will also be checked by
+[GitHub
+Actions](https://github.com/futureverse/future.batchtools/actions?query=workflow%3AR-CMD-check)
+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.

CONDUCT.md

@@ -0,0 +1,18 @@
+# NA
+
+\<% \## Reuse the future vignette md \<-
+R.rsp::rstring(file=“vignettes/future.batchtools.md.rsp”,
+postprocess=FALSE)
+
+## Drop the header, i.e. anything before the first “H2” header
+
+md \<- unlist(strsplit(md, split=“”, fixed=TRUE)) row \<- grep(“^##”,
+md)\[1\] if (!is.na(row)) md \<- md\[-seq_len(row-1)\]
+
+## Drop the footer, i.e. anything after the first horizontal line
+
+row \<- grep(“^—”, md)\[1\] if (!is.na(row)) md \<- md\[seq_len(row-1)\]
+
+## Output
+
+cat(md, sep=“”) %\>

CONTRIBUTING.html

@@ -0,0 +1,114 @@
+# A Future for batchtools
+
+## TL;DR
+
+Here is an example on how to evaluate R expressions on a Slurm
+high-performance compute (HPC) cluster from within R.
+
+``` r
+
+library(future)
+
+# Limit runtime to 10 minutes and memory to 400 MiB per future,
+# request a parallel environment with four slots on a single host.
+# On this system, R is available via environment module 'r'. By
+# specifying 'r/4.5.1', 'module load r/4.5.1' will be added to
+# the submitted job script.
+plan(future.batchtools::batchtools_slurm, resources = list(
+  time = "00:10:00", mem = "400M", nodes = 1, ntasks = 4,
+  modules = c("r/4.5.1")
+))
+
+# Give it a spin
+f <- future({
+  data.frame(
+    hostname = Sys.info()[["nodename"]],
+          os = Sys.info()[["sysname"]],
+       cores = unname(parallelly::availableCores()),
+     modules = Sys.getenv("LOADEDMODULES")
+  )
+})
+info <- value(f)
+print(info)
+#>   hostname    os cores  modules
+#> 1      n12 Linux     4  r/4.5.1
+```
+
+## Introduction
+
+The **[future](https://cran.r-project.org/package=future)** package
+provides a generic API for using futures in R. A future is a simple yet
+powerful mechanism to evaluate an R expression and retrieve its value at
+some point in time. Futures can be resolved in many different ways
+depending on which strategy is used. There are various types of
+synchronous and asynchronous futures to choose from in the
+**[future](https://cran.r-project.org/package=future)** package.
+
+This package,
+**[future.batchtools](https://cran.r-project.org/package=future.batchtools)**,
+provides a type of futures that utilizes the
+**[batchtools](https://cran.r-project.org/package=batchtools)** package.
+This means that *any* type of backend that the **batchtools** package
+supports can be used as a future. More specifically,
+**future.batchtools** will allow you or users of your package to
+leverage the compute power of high-performance computing (HPC) clusters
+via a simple switch in settings - without having to change any code at
+all.
+
+For instance, the below two future R expressions will be processed by
+parallel R workers that launched on different compute nodes by the
+specified job scheduler:
+
+``` r
+
+library(future)
+plan(future.batchtools::batchtools_slurm)
+
+f_x <- future({ Sys.sleep(5); 3.14 })
+f_y <- future({ Sys.sleep(5); 2.71 })
+x <- value(f_x)
+y <- value(f_y)
+x + y
+#> [1] 5.85
+```
+
+This is just a toy example to illustrate what futures look like and how
+to work with them.
+
+For an introduction as well as full details on how to use futures,
+please see <https://www.futureverse.org> or consult the package
+vignettes of the **[future](https://cran.r-project.org/package=future)**
+package.
+
+## Demos
+
+The **[future](https://cran.r-project.org/package=future)** package
+provides a demo using futures for calculating a set of Mandelbrot
+planes. The demo does not assume anything about what type of futures are
+used. *The user has full control of how futures are evaluated*. For
+instance, to use local batchtools futures, run the demo as:
+
+``` r
+
+library(future)
+plan(future.batchtools::batchtools_local)
+demo("mandelbrot", package = "future", ask = FALSE)
+```
+
+## Available batchtools backend
+
+The **future.batchtools** package implements a generic future wrapper
+for all batchtools backends. Below are the most common types of
+batchtools backends. For other types of parallel and distributed
+backends, please see <https://www.futureverse.org/backends.html>.
+
+| Backend | Description | Alternative in future package |
+|:---|:---|:---|
+| `batchtools_lsf` | Futures are evaluated via a [Load Sharing Facility (LSF)](https://en.wikipedia.org/wiki/Platform_LSF) job scheduler | N/A |
+| `batchtools_openlava` | Futures are evaluated via an [OpenLava](https://en.wikipedia.org/wiki/OpenLava) job scheduler | N/A |
+| `batchtools_sge` | Futures are evaluated via a [Sun/Son of/Oracle/Univa/Altair Grid Engine (SGE)](https://en.wikipedia.org/wiki/Oracle_Grid_Engine) job scheduler | N/A |
+| `batchtools_slurm` | Futures are evaluated via a [Slurm](https://en.wikipedia.org/wiki/Slurm_Workload_Manager) job scheduler | N/A |
+| `batchtools_torque` | Futures are evaluated via a [TORQUE](https://en.wikipedia.org/wiki/TORQUE) / PBS job scheduler | N/A |
+| `batchtools_custom` | Futures are evaluated via a custom batchtools configuration R script or via a set of cluster functions | N/A |
+| `batchtools_multicore` | parallel evaluation by forking the current R process | `plan(multicore)` |
+| `batchtools_local` | sequential evaluation in a separate R process (on current machine) | `plan(cluster, workers = I(1))` |