rr-france/bookrr

Readme : liste des clés lacunaire

Closed this issue · 17 comments

@rougier : il manque au moins la clé du chap 6 dans le readme

Sources de non reproductibilité
05_acquisition_des_donnees.md -> {#B-data-acquisition}
Acquisition de l'information
07_donnees_d_entree.md -> {#B-data-input}
Gestion des données
08_aspects_computationnels.md -> {#B-code-aspect}
Programmation et calcul
09_donnees_de_sortie.md -> {#B-data-output}
Communication des résultats

@rougier : dans l'intro du chap 14, j'ai voulu intégrer le renvoi vers le chap 8 en utilisant --> chapitre @ref(B-code-aspect) mais j'obtiens un renvoi vers le chap 6 ??
rappel infos readme (08_aspects_computationnels.md -> {#B-code-aspect}
Programmation et calcul)

Faut voir directement dans le chapitre 8 c'est quoi la bonne clé.

@loicdesquilbet
outre la question de la clé (cf réponse Nicolas), j'ai surtt un doute sur le renvoi au chap 8 ; j'ai gardé la mention initiale "et en particulier le chap.8 "des pbs de calculs"
mais en reprenant le sommaire, j'ai un doute sur l'identification de la section ; est-ce bien tjs le chap "Le temps des changements" vers lequel il ft renvoyer stp?
"Les chapitres précédents (et en particulier le chapitre 8 "Des problèmes de calculs" (chapitre @ref(B-code-aspect)) ont souligné l'importance des questions de diffusion et de partage des codes informatiques. "

@rougier
désolée je reviens sur la liste du readme
en insérant la clé du chap 6, je viens de voir qu'il y a un souci avec le cahp 8 car c'est la même clé qui était inscrite dans le readme

"06_aspects_computationnels.md -> {#B-code-aspect}
Programmation et calcul
07_donnees_d_entree.md -> {#B-data-input}
Gestion des données
08_aspects_computationnels.md -> {#B-code-aspect}
Programmation et calcul"

la clé actuelle du chap 8 serait #C-intro
@rougier je crains d'introduire du bazar dans cette liste du readme ; stp px-tu la reprendre dir toi-même?
merci par avance

Le readme c'était juste pour nous aide pendant le booksprint. Mais comment ça se fait que le chap 6 et 8 ont le même titre ?

Mais en fait tout est moisi dans le readme. On a du faire un changement danss la numérotation à un moment non ? @sabrinagranger tu as utilisé ce README pour faire les renvois ?

non, je n'ai géré que le renvoi du chap 14 peut-être que @loicdesquilbet en sait plus

pour ma question sur le renvoi à inclure en début de chap 14 , Loïc a trouvé et je vais traiter ce point ; pour le pb général, je ne sais pas :
"Ok, j'ai compris d'où venait le pb.
A l'époque du booksprint, le chapitre "programmation et calcul" était le chap. 8. Aujourd'hui, c'est le 6 ! Donc, tu peux retirer la référence au chapitre 8, et ne laisser que celle vers le chapitre 6."

un fois que sera traitée la question de la maj des clés :
"Le readme c'était juste pour nous aide pendant le booksprint. " :
est-ce qu'on ne sortirait pas ces infos du readme (en les mettant dans un autre fichier?)?

Si, bien sûr. Il y a du ménage à faire dans le README. Et à l'occasion, il faudra déplacer tous ces .md dans un répertoire pour que le texte du README.md ne soit pas noyé par le contenu du site sur la page d'accueil de github.

je viens de vérifier les eventuels pbs de renvois de chap et n'en ai trouvé qu'un que j'ai corrigé
je vais faire la maj de la table des clés sur la base des infos dans le texte

I/ Chroniques de la non reproductibilité

00_preambule.md -> {-#A-preambule}
Préambule
01_RR_kezako.md -> {#A-introduction}
Etat des Lieux
02_vis_ma_vie.md -> {#A-personas}
Retours d'expériences
03_questions_cauchemars_recurrents.md -> {#A-cauchermars}
Symptômes d'une recherche non reproductible

II/ Sources de non reproductibilité
04_acquisition_des_donnees.md -> {#B-data-acquisition}
Acquisition de l'information
05_donnees_d_entree.md -> {#B-data-input}
Gestion des données
06_aspects_computationnels.md -> {#B-code-aspect}
Programmation et calcul
07_donnees_de_sortie.md -> {#B-data-output}

III/ Communication des résultats
08_introduction_partie_3.md > {#C-intro}
Solutions de la recherche reproductible
09_collecte_des_donnees.md -> {#C-data-acquisition}
Documenter ses pratiques
10_format_des_donnees.md -> {#C-data-format}
Formater et structurer l'information
11_partage_et_archivage.md -> {#C-data-share}
Partager ses données, codes et résultats
12_outils_de_gestion_de_version.md -> {#C-versioning}
Versionner, versionner, versionner
13_apprendre_a_programmer.md -> {#C-code-learn}
Apprendre à programmer
14_rendre_son_code_comprehensible.md -> {#C-code-good}
Rendre son code compréhensible
15_eviter_les_bugs.md -> {#C-code-bugs}
Exactitude des codes
16_environnement_logiciel.md -> {#C-code-env}
Environnement logiciel
17_licence_et_privacy.md -> {#C-licences}
Sortez couverts !

pas de clés pour les autres fichiers (pas de renvois)

maj de la table des clés faite
svp, je passe la main pour le nettoyage du readme ; je sais pas trop où vous voudriez mettre ces infos

Salut.

J'ai fait un peu de ménage, en particulier, j'ai migré les sources du livre dans un répertoire à part pour que la page d'accueil de github soir un peu plus accueillante... Pour moi c'est bon.

argh ! @alegrand
désolée, je viens de voir que c'est l'ancienne version de la liste des clés qui est dans les docs internes
voici la version corrigée au cas où
I/ Chroniques de la non reproductibilité

00_preambule.md -> {-#A-preambule}
Préambule
01_RR_kezako.md -> {#A-introduction}
Etat des Lieux
02_vis_ma_vie.md -> {#A-personas}
Retours d'expériences
03_questions_cauchemars_recurrents.md -> {#A-cauchermars}
Symptômes d'une recherche non reproductible

II/ Sources de non reproductibilité
04_acquisition_des_donnees.md -> {#B-data-acquisition}
Acquisition de l'information
05_donnees_d_entree.md -> {#B-data-input}
Gestion des données
06_aspects_computationnels.md -> {#B-code-aspect}
Programmation et calcul
07_donnees_de_sortie.md -> {#B-data-output}

III/ Communication des résultats
08_introduction_partie_3.md > {#C-intro}
Solutions de la recherche reproductible
09_collecte_des_donnees.md -> {#C-data-acquisition}
Documenter ses pratiques
10_format_des_donnees.md -> {#C-data-format}
Formater et structurer l'information
11_partage_et_archivage.md -> {#C-data-share}
Partager ses données, codes et résultats
12_outils_de_gestion_de_version.md -> {#C-versioning}
Versionner, versionner, versionner
13_apprendre_a_programmer.md -> {#C-code-learn}
Apprendre à programmer
14_rendre_son_code_comprehensible.md -> {#C-code-good}
Rendre son code compréhensible
15_eviter_les_bugs.md -> {#C-code-bugs}
Exactitude des codes
16_environnement_logiciel.md -> {#C-code-env}
Environnement logiciel
17_licence_et_privacy.md -> {#C-licences}
Sortez couverts !