Package: vmr 0.0.6

Jean-François Rey

vmr: Virtual Machines for R

Manage, provision and use Virtual Machines pre-configured for R. Develop, test and build package in a clean environment. 'Vagrant' tool and a provider (such as 'Virtualbox') have to be installed.

Authors:Jean-François Rey [cre, aut]

vmr_0.0.6.tar.gz
vmr_0.0.6.tar.gz(r-4.7-any)vmr_0.0.6.tar.gz(r-4.6-any)
vmr_0.0.6.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
vmr/json (API)

# Install 'vmr' in R:

install.packages('vmr', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://gitlab.com/rstuff/vmr

Pkgdown/docs site:https://rstuff.gitlab.io

On CRAN:

3.65 score 4 scripts 273 downloads 1 mentions 39 exports 2 dependencies

Last updated from:657591d98e. Checks:4 OK. Indexed: yes.

Target	Result	Time	Files	Syslog
linux-devel-x86_64	OK	102
source / vignettes	OK	187
linux-release-x86_64	OK	115
wasm-release	OK	103

Exports:getProviderOptions virtualboxGitlabRunner virtualboxOptions vmrBoxDownload vmrConfigSSH vmrConnect vmrCreate vmrDestroy vmrDisconnect vmrExec vmrInfo vmrInitEnv vmrInstallPackages vmrIsRunning vmrList vmrListBox vmrListSnapshot vmrLoad vmrLocalBoxList vmrLocalBoxPrune vmrLocalBoxRemove vmrLocalBoxUpdate vmrMountDir vmrPackageBuild vmrPackageCheck vmrPackageTest vmrProvision vmrRemoveSnapshot vmrRestoreSnapshot vmrResume vmrSend vmrSetVerbose vmrStart vmrStatus vmrStop vmrSuspend vmrTakeSnapshot vmrUpdateEnvVersion vmrUpdatePackages

Dependencies:curl jsonlite

1- Working with vmr package

The vmr package | Presentation | Dependencies | Install | Go further | Next vignette : 2-Start my first environment

Rendered fromO1-workwithvmr.Rmdusingknitr::rmarkdown

Last update: 2022-07-08
Started: 2021-02-16

5- Manage vmr Providers

The vmr Providers | Presentation | VirtualBox provider | Vignette summary | Next vignette : 6-Development

Rendered fromO5-vmrManageProviders.Rmdusingknitr::rmarkdown

Last update: 2022-07-08
Started: 2021-02-16

7- Use vmr for CI/CD

CI/CD | GitLab Runner CI/CD | Snapshot | Vignette summary | Next vignette : 8- Functions resume

Rendered fromO7-vmrcicd.Rmdusingknitr::rmarkdown

Last update: 2022-07-08
Started: 2021-02-16

Rendered fromvmrPoster.Rnwusingutils::Sweave

Last update: 2022-07-08
Started: 2022-07-08

2- vmr package first step

To Start | List available environment (boxes) | Create a vmr object | Initialize the vmr environment | Start vmr environment | Stop vmr environment | Vignettes summary | Next vignette : 3-Manage vmr environment

Rendered fromO2-vmrFirstStep.Rmdusingknitr::rmarkdown

Last update: 2021-02-16
Started: 2021-02-16

3- Manage vmr environment

Clarification | Create a vmr environment | Create a vmr object | Load a vmr object | Initialize a vmr environment | Clean a vmr environment | Add options to vmr environment | Upgrade environment | Shared files | Manipulate a vmr environment | Snapshot | Vignette summary | Next vignette : 4-Manage Boxes

Rendered fromO3-vmrManagevmr.Rmdusingknitr::rmarkdown

Last update: 2021-02-16
Started: 2021-02-16

4- Manage vmr boxes

The vmr boxes | Presentation | List boxes | Download a box | Manage boxes | Vignette summary | Next vignette : 5-Manage providers

Rendered fromO4-vmrManageBoxes.Rmdusingknitr::rmarkdown

Last update: 2021-02-16
Started: 2021-02-16

6- Use vmr for development

Develop using vmr package | Information | Run R commands | Package development | Vignette summary | Next vignette : 7-CI/CD

Rendered fromO6-vmrDev.Rmdusingknitr::rmarkdown

Last update: 2021-02-16
Started: 2021-02-16

8- vmr package functions resume

List available boxes | Get box information | Create a vmr environment | Get providers options: | Initialize vmr environment | Load an already initialized vmr environment | Start vmr environment | vmr environment Status: | Get Guest informations: | Save and stop the environment: | Resume an environment previously suspended: | Stop a vmr environment | Remove a vmr environment | Update R packages | Install R packages | Run R commands | Test R package | Check R package | Build R package | Send files and run bash commands | Vignette summary

Rendered fromO8-vmrResume.Rmdusingknitr::rmarkdown

Last update: 2021-02-16
Started: 2021-02-16

Citation

Readme and manuals

Help Manual

Help page	Topics
Virtual Machines for R	vmr-package vmr _PACKAGE
List provider options	getProviderOptions
Print vmr object information	print.vmr
Summary vmr object information	summary.vmr
Configure the guest VM to be use as a Gitlab-Runner	virtualboxGitlabRunner
List 'VirtualBox' options available	virtualboxOptions
Download a Box	vmrBoxDownload
Configure ssh	vmrConfigSSH
Open a ssh connection to guest machine	vmrConnect
Create a vmr environment class	vmrCreate
Remove all resources created in a vmr environment	vmrDestroy
Disconnect ssh connection to guest machine	vmrDisconnect
Execute R methods into guest machine	vmrExec
Get guest machine information	vmrInfo
Initialize the vmr environment	vmrInitEnv
Install R packages into guest machine	vmrInstallPackages
Is vmr environment running	vmrIsRunning
List available boxes from VagrantCloud	vmrList
List all available version of a box	vmrListBox
List snapshot of the guest machine	vmrListSnapshot
Load a vmr environment containing a Vagrant file	vmrLoad
List downloaded boxes	vmrLocalBoxList
Remove old installed boxes	vmrLocalBoxPrune
Remove a box from localhost	vmrLocalBoxRemove
Update local box version	vmrLocalBoxUpdate
Mount a host directory to guest	vmrMountDir
Build a package in the guest machine	vmrPackageBuild
Perform a package check on guest	vmrPackageCheck
Test a package into a guest machine	vmrPackageTest
Provision a vmr environment	vmrProvision
remove a snapshot of the guest machine	vmrRemoveSnapshot
Restore a snapshot of the guest machine	vmrRestoreSnapshot
Resume a stopped guest machine	vmrResume
Send files and/or directories to guest machine	vmrSend
Set verbose level	vmrSetVerbose
Start a vmr environment	vmrStart
Get the state of the guest machine	vmrStatus
Stop a vmr environement	vmrStop
Save state and stop guest machine	vmrSuspend
Take a snapshot of the guest machine	vmrTakeSnapshot
Update a vmr environment.	vmrUpdateEnvVersion
Update R packages installed	vmrUpdatePackages

Usage by other packages (reverse dependencies)