Skip to content

Commit 036032f

Browse files
author
Davis
committed
adding readme.rmd file
1 parent a99e16d commit 036032f

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
^.*\.Rproj$
22
^\.Rproj\.user$
3+
^README\.Rmd$

README.Rmd

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
output: github_document
3+
---
4+
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
6+
7+
```{r, include = FALSE}
8+
knitr::opts_chunk$set(
9+
collapse = TRUE,
10+
comment = "#>",
11+
fig.path = "man/figures/README-",
12+
out.width = "100%"
13+
)
14+
```
15+
16+
# clusterapply
17+
18+
<!-- badges: start -->
19+
<!-- badges: end -->
20+
21+
Clusterapply is meant to break datasets into smaller frames on which functions (regressions, for example) can be applied. Much of this can already be accomplished with the family of *apply functions, but here we are building towards parallelization with an eye on memory use. The package does not yet contain all intended features and should be considered provisional.
22+
23+
This package is used primarily in the EPIDEMIA forecasting system’s epidemiar package: https://github.com/EcoGRAPH/epidemiar/releases/latest with an associated demonstration project available at: https://github.com/EcoGRAPH/epidemiar-demo/releases/latest
24+
25+
## Installation
26+
27+
The development version, whenever public, is available from [GitHub](https://github.com/) with:
28+
29+
``` r
30+
# install.packages("devtools")
31+
devtools::install_github("EcoGRAPH/clusterapply")
32+
```
33+
## Example
34+
35+
Please see the associated ca-vignette.Rmd file for an example of clusterapply's use.

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
<!-- README.md is generated from README.Rmd. Please edit that file -->
3+
4+
# clusterapply
5+
6+
<!-- badges: start -->
7+
8+
<!-- badges: end -->
9+
10+
Clusterapply is meant to break datasets into smaller frames on which
11+
functions (regressions, for example) can be applied. Much of this can
12+
already be accomplished with the family of \*apply functions, but here
13+
we are building towards parallelization with an eye on memory use. The
14+
package does not yet contain all intended features and should be
15+
considered provisional.
16+
17+
This package is used primarily in the EPIDEMIA forecasting system’s
18+
epidemiar package:
19+
<https://github.com/EcoGRAPH/epidemiar/releases/latest> with an
20+
associated demonstration project available at:
21+
<https://github.com/EcoGRAPH/epidemiar-demo/releases/latest>
22+
23+
## Installation
24+
25+
The development version, whenever public, is available from
26+
[GitHub](https://github.com/) with:
27+
28+
``` r
29+
# install.packages("devtools")
30+
devtools::install_github("EcoGRAPH/clusterapply")
31+
```
32+
33+
## Example
34+
35+
Please see the associated ca-vignette.Rmd file for an example of
36+
clusterapply’s use.

0 commit comments

Comments
 (0)