Skip to content

Commit

Permalink
update vignette link
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Oct 2, 2023
1 parent 74ccaa0 commit 18aeeab
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
6 changes: 5 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,11 @@ call_mirai(m)$data |> str()
```


Refer to the '**reference**' vignette for the full package functionality, which includes launching daemons, which are persistent background processes on local or remote machines.
Refer to the ['reference'](https://shikokuchuo.net/mirai/articles/reference.html) vignette for the full package functionality, which includes launching daemons - persistent background processes on local or remote machines. This may be accessed within R by:

```{r vignette, eval=FALSE}
vignette("reference", package = "mirai")
```

### Use with Parallel

Expand Down
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,26 @@ result.

``` r
m$data |> str()
#> num [1:100000000] 1.362 -1.846 0.473 0.666 -3.015 ...
#> num [1:100000000] -1.163 -5.3031 -0.8701 2.7348 -0.0317 ...
```

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

``` r
call_mirai(m)$data |> str()
#> num [1:100000000] 1.362 -1.846 0.473 0.666 -3.015 ...
#> num [1:100000000] -1.163 -5.3031 -0.8701 2.7348 -0.0317 ...
```

Refer to the ‘**reference**’ vignette for the full package
functionality, which includes launching daemons, which are persistent
background processes on local or remote machines.
Refer to the
[‘reference’](https://shikokuchuo.net/mirai/articles/reference.html)
vignette for the full package functionality, which includes launching
daemons - persistent background processes on local or remote machines.
This may be accessed within R by:

``` r
vignette("reference", package = "mirai")
```

### Use with Parallel

Expand Down

0 comments on commit 18aeeab

Please sign in to comment.