This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Installation

How to install LinkR on R or from a Docker image

LinkR can be installed and launched from RStudio or run as a Docker container.

Installation on RStudio

The remotes library will be required for the installation of LinkR. You can install it with this command:

install.packages("remotes")

Stable version

Install the latest stable version with this command:

remotes::install_gitlab("interhop/linkr/linkr", host = "framagit.org")

Development version

To install the latest development version, add @dev to the end of the git repository link.

remotes::install_gitlab("interhop/linkr/linkr@dev", host = "framagit.org")

Important - shiny.fluent version

Version 0.3.0 of shiny.fluent required


You also need to install version 0.3.0 of shiny.fluent.

By default, version 0.4.0 is installed, but it has unresolved bugs.

remotes::install_github('Appsilon/shiny.fluent', ref = 'dd1c956')

Start LinkR

To start LinkR from RStudio or an R console, use the linkr function:

linkr::linkr()

You can set the language by specifying the language argument. Available options are “fr” (French) and “en” (English).

linkr::linkr(language = "fr")

By default, LinkR files are saved in your home directory (which you can locate by running path.expand("~")). To change the location, use the app_folder argument to specify your desired directory.

linkr::linkr(language = "fr", app_folder = "/home/username")

To display log messages in the console, set the debug argument to TRUE.

linkr::linkr(language = "fr", app_folder = "/home/username", debug = TRUE)

This will output all log messages to the R console. If you prefer to store these messages in a log file accessible through the LinkR interface, set the log_file argument to TRUE.

linkr::linkr(language = "fr", app_folder = "/home/username", debug = TRUE, log_file = TRUE)

Using a Docker image

If Docker is already installed

Pull the Docker image from Docker Hub.

docker pull interhop/linkr:latest

Run a container from this image.

docker run -p 3838:3838 interhop/linkr:latest

You can now access LinkR at http://localhost:3838.

You can also launch LinkR by changing the arguments of the linkr function (see the previous section).

docker run \
    -p 3838:3838 \
    interhop/linkr:latest \
    R -e "linkr::linkr(language = 'fr', app_folder = '/root', debug = TRUE)"

To allow the container to access a specific folder from your host system (e.g., /my_personal_folder/linkr), you can mount this folder inside the container. This is done using the -v option when launching the container.

docker run \
    -p 3838:3838 \
    -v /my_personal_folder/linkr:/root \
    interhop/linkr:latest \
    R -e "linkr::linkr(language = 'fr', app_folder = '/root', debug = TRUE)"

Here, we have correctly configured the app_folder argument of the linkr function to save the application’s files in the /root directory, which will actually be the folder on your system that you specified with the -v option.

Installing Docker

On Windows or macOS

  1. Download Docker Desktop
  2. Install and launch Docker Desktop by following the instructions.
  3. Verify that Docker is working by opening a terminal (PowerShell or CMD on Windows) and running:
docker --version

On Linux

  1. Install Docker depending on your Linux distribution.
sudo apt-get update
sudo apt-get install -y docker.io
sudo dnf install docker
sudo pacman -S docker
  1. Start the Docker service.
sudo systemctl start docker
  1. Add your user to the Docker group to avoid using sudo (optional).
sudo usermod -aG docker $USER

Log out and log back in to apply the changes.

  1. Verify that Docker is working.
docker --version