Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kennedymwavu/rmon
R's equivalent of nodemon
https://github.com/kennedymwavu/rmon
Last synced: 16 days ago
JSON representation
R's equivalent of nodemon
- Host: GitHub
- URL: https://github.com/kennedymwavu/rmon
- Owner: kennedymwavu
- License: other
- Created: 2024-08-10T20:18:34.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T22:45:07.000Z (19 days ago)
- Last Synced: 2024-10-26T10:44:27.786Z (18 days ago)
- Language: R
- Homepage: https://kennedymwavu.github.io/rmon/
- Size: 3.47 MB
- Stars: 21
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
# rmon
[](https://CRAN.R-project.org/package=rmon)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
R's equivalent of [nodemon](https://nodemon.io/). Designed to make development easier by automatically reloading your R scripts and applications.
can be used to auto-reload:
- arbitrary R scripts
- apps & apis:
- shiny
- ambiorix
- plumber
**rmon** will monitor your source files for any changes and automatically restart/rerun your server. this allows you to focus on coding without manually restarting your server every time you make a change.
just like nodemon, **rmon** is perfect for development.
# installation
to install the package from CRAN use:
```r
install.packages("rmon")
```
install the dev version from GitHub:
```r
remotes::install_github(repo = "kennedymwavu/rmon")
```
# usage
```r
rmon::monitor(
dir = ".",
file = "app.R"
)
```
- `dir`: character vector. directory to monitor for changes
- `file`: file to rerun when changes are detected in the directory
# monitoring multiple directories
```r
rmon::monitor(
dir = c("path-to-first-dir", "path-to-another-dir"),
file = "app.R"
)
```
if multiple directories are specified, `file` is assumed to be in the first
directory.
# specify extension watch list
by default, `{rmon}` monitors all files in `dir` for changes.
to watch only `.R`, `.html`, `.css` and `.js` files, set the `ext` parameter:
```r
rmon::monitor(
dir = ".",
file = "app.R",
ext = c("R", "html", "css", "js")
)
```
# ignoring files
to ignore the file `dev.R`, do:
```r
rmon::monitor(
dir = ".",
file = "app.R",
exclude_files = "dev.R"
)
```
to ignore the directory `test/`:
```r
rmon::monitor(
dir = ".",
file = "app.R",
exclude_dirs = "test"
)
```
to ignore all files whose names match the pattern `test`:
```r
rmon::monitor(
dir = ".",
file = "app.R",
exclude_patterns = "test"
)
```
to ignore changes to hidden files, set `monitor_hidden = FALSE`:
```r
rmon::monitor(
dir = ".",
file = "app.R",
monitor_hidden = FALSE
)
```
# delaying restarting
in some situations, you may want to delay restarting until multiple files have changed.
by default, **rmon** checks for file changes every second.
if you're uploading or modifying multiple files, this can lead to unnecessary multiple restarts of your application.
to delay restarting and avoid this issue, use the `delay` parameter:
```r
rmon::monitor(
dir = ".",
file = "app.R",
delay = 10
)
```
- `delay`: a length one numeric. number of seconds to wait before checking for file changes again.