Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Solymos <psolymos@gmail.com>
  • Loading branch information
psolymos committed Oct 16, 2023
1 parent ee527bc commit 60a5662
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Book**](https://peter.solymos.org/qpad-book/).
Check out the [**QPAD
workshop**](https://peter.solymos.org/qpad-workshop/).

Read/cite the paper *Agent-based simulations improve abundance
estimation*, [DOI](https://doi.org/10.1007/s42977-023-00183-2).

## Install

CRAN version:
Expand All @@ -56,6 +59,11 @@ See what is new in the [NEWS](NEWS.md) file.

[GPL-2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)

Please cite (see `citation("bSims")`) the paper:

Solymos, P. 2023. Agent-based simulations improve abundance estimation.
*Biologia Futura*, [DOI](https://doi.org/10.1007/s42977-023-00183-2).

## Contributing

Feedback and contributions are welcome:
Expand Down Expand Up @@ -164,23 +172,23 @@ nc <- 2 # number of cores
## sequential
system.time(bb <- b$replicate(B, cl=NULL))
#> user system elapsed
#> 0.226 0.002 0.227
#> 0.225 0.003 0.227

## parallel clusters
cl <- makeCluster(nc)
## note: loading the package is optional
system.time(clusterEvalQ(cl, library(bSims)))
#> user system elapsed
#> 0.000 0.000 0.502
#> 0.000 0.000 0.514
system.time(bb <- b$replicate(B, cl=cl))
#> user system elapsed
#> 0.004 0.001 0.186
#> 0.005 0.001 0.180
stopCluster(cl)

## parallel forking
if (.Platform$OS.type != "windows") {
system.time(bb <- b$replicate(B, cl=nc))
}
#> user system elapsed
#> 0.132 0.036 0.169
#> 0.130 0.039 0.171
```
2 changes: 2 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Bayne
Biologia
CoC
DApq
DOI
Dua
Extensibility
Fontaine
Futura
Getter
Lele
Lipa
Expand Down

0 comments on commit 60a5662

Please sign in to comment.