Best Practices R
Last updated
Last updated
If you like vscode theme, use https://github.com/anthonynorth/rscodeio
devtools::dev_mode
function switches your version of R into "development mode". This is useful to avoid clobbering the existing versions of CRAN packages that you need for other tasks. Calling dev_mode() again will turn development mode off, and return you to your default library setup.
or Ctrl + Shift + L
.R
files defined in tests\dev\
will be removed from the package and can be used to simulate interaction with the package. See
Coding standards are described
Examples of packages that can serve as inspiration:
Show all shortcuts: Alt+Shift+K
Reload package: Cmd + Shift + L
Navigate to: Ctrl + .
Generate Doc: Ctrl + Shift + D
Run unit tests: Ctrl + Shift + T
Navigate to implementation: Mouse over + F2
or CTRL + Mouse Click
Un-/Comment line/selection: Ctrl + Shift + C
Multi-select: CTRL+SHIFT+ALT+M
Short summary:
The first time a test with snapshot is executed, it creates a snapshot file that will be considered the truth. Therefore it is important to check this file for its validity.
If the behavior of the tested function changes, the test will fail, as the new output will differ from the snapshot.
Run snapshot_review()
to compare the new output with the snapshot.
If the new behavior is correct, accept the snapshot by calling snapshot_accept()
.
If build fails because of failing snapshot tests, never accept new snapshots without manual review.
As an example, a Hyper-V Virtual Machine under Windows 10 is used. Currently tested with Ubuntu 19.10
Install Ubuntu
Download Ubuntu from https://ubuntu.com/download/desktop
Tutorial: https://www.youtube.com/watch?v=oyNjjzg-UXo = >This is a very good intro to get ubuntu installed from scratch
Install git
sudo apt install git
Install nuget
sudo apt install nuget
Install R
sudo apt install r-base
Install R Studio
Install devtools
sudo apt update
sudo apt-get install libcurl4-openssl-dev
sudo apt-get install libssl-dev
sudo apt install libxml2-dev
Install devtool from R Studio from CRAN
Install mono (as described here https://www.mono-project.com/download/stable/)
sudo apt install gnupg ca-certificates
sudo apt autoremove
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
Install the 5.18 version, as the latest stable is bugged atm: echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic/snapshots/5.18 main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
LATEST DOES NOT WORK AT THE MOMENT
Alternative: install latest stable: echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update
sudo apt install mono-complete
Install some missing dependencies required to build rClr
sudo apt-get install libglib2.0-dev
Install .NET SDK
See https://aka.ms/dotnet-download
Profiling of code can be done within R-Studio with the package profvis
, a description of the process is given . In short, pass the code to be profiled as argument to the function profvis
:
{ospsuite}
uses snapshots to test the behavior of plot functions. Read for information on how to.
Download R studio from
Optionally: Install