Version imprimable multipages. Cliquer ici pour imprimer.

Retour à la version par défaut.

Installation

Comment installer LinkR, sur R / RStudio ou depuis une image Docker

Introduction

Plusieurs méthodes d'installation sont disponibles :


  • La plus simple (aucune connaissance en programmation requise) : utilisez Docker Desktop
  • En ligne de commande : vous pouvez lancer l’image Docker depuis un terminal ou installer le package via une console R.
  • Pour les développeurs : Clonez le dépôt Git pour pouvoir éditer le code source.

Installation avec Docker Desktop (méthode recommandée)

Cette méthode est la plus simple et ne nécessite aucune connaissance en programmation.

Installer Docker sur Windows ou macOS

  1. Téléchargez Docker Desktop
  2. Installez et lancez Docker Desktop

Dans le menu à gauche, cliquez sur Docker Hub, cela vous permettra de chercher et d’installer l’image de LinkR.

Chercher interhop/linkr dans la barre de recherche.

Cliquez sur l’onglet Tags puis cliquez sur cette image.

A droite de l’écran, sélectionnez la dernière image (latest), et cliquez sur Pull pour l’installer.

Retournez sur la page Images à gauche de l’écran. Vous verrez la liste des images installées localement.

Depuis l’image interhop/linkr, cliquez sur l’image Play dans la colonne Actions.

Vous aurez alors cet écran.

Déroulez le menu Optional settings.

Vous aurez à modifier ceci :

  • Host port : indiquez 3838
  • Host path : c’est le dossier local où seront installés les fichiers permettant le fonctionneemnt de l’application
  • Container path : il faut mettre /root

Cliquez ensuite sur Run, ouvrez votre navitageur et copiez l’URL suivante : localhost:3838⁠.

Installation en ligne de commande

Via Docker

Installez Docker Desktop comme décrit ci-dessus.

Vérifiez que Docker fonctionne en ouvrant un terminal (PowerShell ou CMD sur Windows) et en exécutant :

docker --version

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 localhost:3838.

Vous pouvez également lancer LinkR en changeant les arguments de la fonction run_app (cf paragraphe suivant).

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

Voici les arguments de run_app :

Argument Description
language Langue de l’application. Peut être "fr" pour le français ou "en" pour l’anglais. (character)
app_folder Dossier où seront stockés les fichiers de l’application dans le conteneur. (character)
authentication Active ou non l’authentification utilisateur (TRUE ou FALSE). (logical)
username Identifiant à utiliser pour une connexion automatique lorsque authentication = FALSE. Ignoré si l’authentification est activée. (character)
local Si TRUE, l’application tourne en mode local sans charger de fichiers externes (ex. : depuis GitHub). (logical)
log_level Niveaux de logs à afficher. Peut inclure "info", "error", "event", ou "none" pour désactiver les logs. (character vector)
log_target Destination des logs : "console" ou "app". (character)
port Port utilisé pour exécuter l’application Shiny. (integer)
host Adresse hôte pour exécuter l’application (par défaut "0.0.0.0"). (character)
loading_options Liste d’options de démarrage (page, projet, filtre, etc.) : peut inclure des éléments nommés comme page, project_id, load_data_page, subset_id, person_id. (list)


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::run_app(language = 'fr', app_folder = '/root')"

On a ici bien configuré l’argument app_folder de la fonction run_app 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.

Via RStudio / Console R

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::run_app()

Voir ci-dessus pour les arguments que peut prendre la fonction.

Installation pour les développeurs

Clonez le dépôt Git officiel de LinkR depuis Framagit :

git clone git@framagit.org:interhop/linkr/linkr.git
cd linkr

Assurez-vous d’avoir configuré une clé SSH pour accéder à Framagit. Sinon, vous pouvez aussi utiliser l’URL HTTPS :
https://framagit.org/interhop/linkr/linkr.git

Placez vous sur la branche dev :

git checkout dev

Ouvrez le dossier du projet dans RStudio ou Visual Studio Code (avec l’extension R activée).

Chargez le package avec devtools, en éxécutant ceci dans la console R :

install.packages("devtools")  # Si ce n'est pas déjà fait
devtools::load_all(".")

Lancez l’application en éxécutant ceci :

linkr::run_app()

Conclusion

Nous avons installé et lancé LinkR.


Voyons maintenant comment lancer notre premier projet.