Skip to content

Commit

Permalink
revert description wording
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Dec 23, 2023
1 parent d7ad4c4 commit 7ac86f7
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 18 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Description: Lightweight parallel code execution and distributed computing.
Designed for simplicity, a 'mirai' evaluates an R expression asynchronously,
on local or network resources, resolving automatically upon completion.
Efficient scheduling over fast inter-process communications or secure TLS
over TCP/IP connections, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
Authors@R:
c(person(given = "Charlie",
family = "Gao",
Expand Down
5 changes: 3 additions & 2 deletions R/mirai-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@
#' Lightweight parallel code execution and distributed computing. Designed for
#' simplicity, a 'mirai' evaluates an R expression asynchronously, on local
#' or network resources, resolving automatically upon completion. Efficient
#' scheduling over fast inter-process communications or secure TLS over
#' TCP/IP connections, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
#' scheduling over fast inter-process communications or secure TLS
#' connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next
#' Gen).
#'
#' @section Notes:
#'
Expand Down
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Designed for simplicity, a 'mirai' evaluates an R expression asynchronously, on
<br /><br />
`mirai()` returns a 'mirai' object immediately. 'mirai' (未来 みらい) is Japanese for 'future'.
<br /><br />
Efficient scheduling over fast inter-process communications or secure TLS over TCP/IP connections, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
Efficient scheduling over fast inter-process communications or secure TLS connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
<br /><br />
{mirai} has a tiny pure R code base, relying solely on [`nanonext`](https://doi.org/10.5281/zenodo.7903429), a high-performance binding for the 'NNG' (Nanomsg Next Gen) C library with zero package dependencies.
<br /><br />
Expand Down Expand Up @@ -64,7 +64,7 @@ m <- mirai(
res <- rnorm(x) + y ^ 2
res / rev(res)
},
x = 11,
x = 10,
y = runif(1)
)
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ for simplicity, a ‘mirai’ evaluates an R expression asynchronously, on
local or network resources, resolving automatically upon completion.
<br /><br /> `mirai()` returns a ‘mirai’ object immediately. ‘mirai’
(未来 みらい) is Japanese for ‘future’. <br /><br /> Efficient
scheduling over fast inter-process communications or secure TLS over
TCP/IP connections, built on ‘nanonext’ and ‘NNG’ (Nanomsg Next Gen).
<br /><br /> {mirai} has a tiny pure R code base, relying solely on
[`nanonext`](https://doi.org/10.5281/zenodo.7903429), a high-performance
binding for the ‘NNG’ (Nanomsg Next Gen) C library with zero package
dependencies. <br /><br />
scheduling over fast inter-process communications or secure TLS
connections over TCP/IP, built on ‘nanonext’ and ‘NNG’ (Nanomsg Next
Gen). <br /><br /> {mirai} has a tiny pure R code base, relying solely
on [`nanonext`](https://doi.org/10.5281/zenodo.7903429), a
high-performance binding for the ‘NNG’ (Nanomsg Next Gen) C library with
zero package dependencies. <br /><br />

### Installation

Expand Down Expand Up @@ -56,7 +56,7 @@ m <- mirai(
res <- rnorm(x) + y ^ 2
res / rev(res)
},
x = 11,
x = 10,
y = runif(1)
)

Expand Down Expand Up @@ -88,17 +88,17 @@ result.

``` r
m$data
#> [1] 0.2390802 1.0470625 2.8110633 0.1733852 1.6094568 1.0000000 0.6213276
#> [8] 5.7675056 0.3557373 0.9550528 4.1826971
#> [1] -0.67343605 -0.20497828 50.37872905 1.48134108 0.37001452 2.70259664
#> [7] 0.67506398 0.01984965 -4.87856556 -1.48492199
```

Alternatively, explicitly call and wait for the result using
`call_mirai()`.

``` r
call_mirai(m)$data
#> [1] 0.2390802 1.0470625 2.8110633 0.1733852 1.6094568 1.0000000 0.6213276
#> [8] 5.7675056 0.3557373 0.9550528 4.1826971
#> [1] -0.67343605 -0.20497828 50.37872905 1.48134108 0.37001452 2.70259664
#> [7] 0.67506398 0.01984965 -4.87856556 -1.48492199
```

### Vignette
Expand Down
5 changes: 3 additions & 2 deletions man/mirai-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7ac86f7

Please sign in to comment.