Installation

Comment installer LinkR, sur R ou depuis une image Docker

LinkR peut être installé et lancé depuis RStudio ou être lancé en tant que container Docker.

Installation sur RStudio

La librairie remotes sera nécessaire pour l’installation de LinkR. Vous pouvez l’installer avec cette commande :

install.packages("remotes")

Version stable

Installez la dernière version stable avec cette commande :

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

Version en développement

Pour installer la dernière version en développement, ajouter @dev à la fin du lien du dépôt git.

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

Important - version de shiny.fluent

La version 0.3.0 de shiny.fluent est nécessaire


Vous devez également installer la version 0.3.0 de shiny.fluent.

Par défaut, c’est la version 0.4.0 qui est installée mais elle présente des bugs non résolus.

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

Démarrer LinkR

Pour lancer LinkR depuis RStudio ou depuis une console R, exécutez la fonction linkr.

linkr::linkr()

Vous pouvez choisir la langue en changeant l’argument language. Vous avez le choix parmi “fr” et “en”.

linkr::linkr(language = "fr")

Par défaut, les fichiers de LinkR seront sauvegardés dans votre dossier Home (que vous pouvez retrouver en exécutant path.expand("~")). Vous pouvez changer l’argument app_folder et choisir le dossier de votre choix.

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

Si vous voulez afficher le log dans la console, ajouter l’argument debug avec la valeur TRUE.

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

Ceci affichera tous les messages dans la console de R. Si vous préférez stocker ces messages dans un fichier de log accessible depuis LinkR, renseignez log_file à TRUE.

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

A partir d’une image Docker

Si Docker est déjà installé

Copiez l’image Docker depuis Docker Hub.

docker pull interhop/linkr:latest

Lancez un container depuis cette image.

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

Vous pouvez maintenant accéder à LinkR via l’adresse http://localhost:3838.

Vous pouvez également lancer LinkR en changeant les arguments de la fonction linkr (cf paragraphe précédent).

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

Pour permettre au conteneur d’accéder à un dossier spécifique de votre système hôte (par exemple, /mon_dossier_perso/linkr), vous pouvez monter ce dossier dans le conteneur. Cela se fait avec l’option -v lors du lancement du conteneur.

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

On a ici bien configuré l’argument app_folder de la fonction linkr pour sauvegarder les fichiers de l’application dans le dossier /root, qui sera en réalité le dossier de votre système que vous aurez indiqué avec l’option -v.

Installer Docker

Sur Windows ou macOS

  1. Téléchargez Docker Desktop
  2. Installez et lancez Docker Desktop en suivant les instructions
  3. Vérifiez que Docker fonctionne en ouvrant un terminal (PowerShell ou CMD sur Windows) et en exécutant :
docker --version

Sur Linux

  1. Installez Docker en fonction de votre distribution Linux.
sudo apt-get update
sudo apt-get install -y docker.io
sudo dnf install docker
sudo pacman -S docker
  1. Démarrez le service Docker.
sudo systemctl start docker
  1. Ajoutez votre utilisateur au groupe Docker pour éviter d’utiliser sudo (optionnel).
sudo usermod -aG docker $USER

Déconnectez-vous et reconnectez-vous pour appliquer les changements.

  1. Vérifiez que Docker fonctionne.
docker --version
Dernière modification 04.01.2025: Update CSS in EN doc (#11) (5decb71)