1.1 Contenu

Les auteur·e·s sont libres dans le choix de la problématique et dans la façon d’articuler le contenu. Les seules obligations en matière de contenu sont :

• Une fiche doit être rédigée en français ou en anglais.
• Les traitements présentés doivent être reproductibles et respecter le RGPD.
• Les données utilisées doivent être accessibles.
• Une fiche doit contenir une introduction qui contextualise le contenu présenté.
• Certaines annexes sont obligatoires (information sur la session et citation de la fiche) ou fortement recommandés (glossaire et références bibliographiques).

L’évaluation d’une fiche repose sur un ensemble de critères d’évaluation consultables dans partie 2.

1.2 Format

Une fiche Rzine est un fichier HTML produit en R Markdown. Elle se construit donc avec R et repose sur les packages rmarkdown et knit.

Une fiche doit respecter une mise en page ainsi qu’une structure prédéfinie de répertoire. Pour faciliter cela, un modèle pré-rempli est mis à disposition par le package rzine. L’installation du package et la génération d’une fiche Rzine vierge est expliquée dans la partie 3.1

1.3 Stockage et déploiement

Rzine souhaite promouvoir l’usage de logiciels contribuant à une science plus ouverte et reproductible. L’analyse, le code et les données doivent être publics et accessibles depuis un logiciel de gestion de version décentralisé. Ainsi, pour qu’une fiche soit acceptée en relecture, elle doit impérativement être mise à disposition sur un Git (GitHub ou GitLab) et déployée, c’est à dire consultable, depuis celui-ci.

Cela ne doit en aucun cas effrayer les auteur.e.s qui n’ont jamais utilisé ce genre de logiciel. De la documentation et une assistance sont fournies par le comité éditorial Rzine… Profitez-en pour vous former à cet outil qui change la vie !

Retrouvez plus de précisions à ce sujet dans la partie 3.2

1.4 Évaluation

Chaque fiche publiée dans la collection Rzine fait l’objet d’une relecture par un·e ou de plusieurs expert·e·s de la thématique (ou méthode/technique) et d’un contrôle éditorial par des membres du comité de lecture.

Le processus de relecture se veut complètement transparent. L’ensemble des retours, ajouts ou modifications demandés, ainsi que l’identité des relecteur·rice·s sont publics.

Ce processus de relecture se fait en intégralité via GitHub ou GitLab. De la documentation et une assistance sont fournies par le comité éditorial Rzine pour vous aider si nécessaire. Retrouvez plus de précisions à ce sujet dans la partie 3.3

1.5 Licence d’utilisation

L’ensemble des fiches Rzine sont soumises aux conditions d’utilisation de la licence CC BY-SA 4.0.

Cette licence autorise le partage, la distribution, la modification et la diffusion pour toute utilisation, y compris commerciale selon les conditions d’attribution et de partage dans les mêmes conditions. Afin d’éviter tout malentendu avec les auteur·e·s, la signature d’un accord de principe est obligatoire.

3.1 Édition

Une fiche Rzine est un fichier HTML produit en R Markdown à partir d’un modèle de mise en page fournit par le package rzine. Ce modèle de mise en page fournit également toute l’infrastructure de répertoires et les fichiers associés (vierges) demandés à la soumission d’une fiche.

Le package est mis à disposition sur un dépôt de l’organisation Rzine sur le GitLab Huma-Num.
Pour l’installer, exécutez les lignes suivantes :

# install.packages(remotes)
remotes::install_gitlab("rzine/package", host = "https://gitlab.huma-num.fr/", force = TRUE)
library(rzine)

Vous pouvez ensuite générer une fiche Rzine vierge en clic-bouton depuis l’interface Rstudio (File > New File > R Markdown > From temmplate) ou utiliser la fonction suivante :

rmarkdown::draft(file = "index.Rmd", 
                 template = "readrzine", 
                 package = "rzine", 
                 create_dir = FALSE, 
                 edit = FALSE)

Retrouvez l’ensemble du processus d’édition expliqué et détaillé dans ce document, Comité éditorial Rzine (2021c).

3.2 Soumission

Une fois votre fiche rédigée et générée en format HTML, soumettez-la au comité de lecture. Pour cela, vous devez déposer l’ensemble du répertoire sur un dépôt GitHub, puis déployer votre fiche afin de la rendre consultable en ligne… Vous ne comprenez rien ? Ce n’est pas grave, de la documentation ainsi que l’équipe Rzine sont là pour vous accompagner dans ce processus.

La soumission d’une fiche peut se résumer en quatre étapes :

1. Créer un compte GitHub (si ce n’est pas déjà fait).
2. Créer un nouveau dépôt puis y déposer l’ensemble de votre répertoire.
3. Déployer votre fiche en format HTML pour la rendre consultable en ligne.
4. Envoyer un mail à contact@rzine.fr pour alerter le comité de lecture de votre soumission.

Retrouvez toutes les informations nécessaires pour vous accompagner dans le processus de soumission dans cette documentation, Comité éditorial Rzine (2021b).

Au regard de la ligne éditoriale de la collection, le comité de lecture statue sur la validité d’une soumission sous 15 jours.

3.3 Relecture

En cas de soumission validée, un relecteur·rice doté·e des connaissances techniques et thématiques nécessaires sera proposé·e à l’auteur·e dans les 15 jours.

Rzine est dans une démarche volontariste d’Open Science. La relecture des fiches Rzine est ouverte et transparente. L’identité du ou des relecteur·rice·s et l’ensemble de leurs retours sont publics.

Parce qu’une fiche est un document computationnel, l’ensemble du processus se déroule sur GitHub. Vous serez donc invité·e à ouvrir les droits du dépôt GitHub de votre fiche au relecteur·rice désigné·e. Les retours et les demandes d’améliorations se feront directement sur la plateforme GitHub via des issues et des pull-request.

Si vous n’avez aucune pratique ni connaissance de GitHub, une documentation complète est mise à votre disposition ici, Comité éditorial Rzine (2021a), pour vous accompagner dans le processus de relecture. Les éditeurs du comité de lecture pourront également vous assister dans ce processus.

3.4 Publication

Une fois les demandes d’améliorations prises en compte et la publication validée par l’évaluateur·rice, une fiche de métadonnées associée à la publication vous sera demandée afin d’assurer son référencement sur Rzine.fr.

Votre dépôt est ensuite cloné dans le dépôt GitLab Rzine, et la publication déployée depuis celui-ci. Un DOI sera associé à la publication, qui sera également référencée sur HAL et sur Rzine.fr.