Fiche : comment se documenter sous R #74

Closed linogaliana closed 3 years ago

In GitLab by @sylvain.daubree on Jun 23, 2020, 07:10

Avant de faire un premier jet de la fiche comment trouver de l'information sur R, je propose d'échanger dans cette issue sur le plan qu'on pourrait utiliser. Voilà ce que j'imagine, dites moi ce que vous en pensez :

Je pense faire deux grandes parties (mais peut-être sont-ce deux fiches distinctes ?) : d'abord se documenter, récupérer de l'information nouvelle, acquérir de nouvelles compétences, et ensuite répondre à une question, résoudre un bug ou une difficulté. ça pourrait donner quelque chose comme ça :

Se documenter
1. récupérer la documentation d'une fonction (? ou help() directement dans RStudio)
2. la documentation d'un package, avec ses vignettes
3. la veille sur R (avec quelques blogs, quelques comptes twitter, rejoindre ou créer un GUR)
Résoudre un problème
1. comment poser une question (en s'inspirant de la fiche de SO, MWE et compagnie)
2. les ressources SSP (rocket chat, tchap, LS²)
3. les ressources francophones (j'ai en tête le forum du cirad et developpez.com, sans trop savoir si c'est encore vraiment actif, je ne les ai pas pratiqué depuis quelques temps)
4. les ressources anglophones (SO avec une présentation peut-être un peu plus complète du fonctionnement)

Qu'en pensez-vous ?

In GitLab by @sylvain.daubree on Jun 23, 2020, 07:10

changed due date to July 24, 2020

In GitLab by @linogaliana on Jun 23, 2020, 07:34

Ton plan me convient, je trouve la distinction doc/problème intéressante. Je mettrai bien Rbloggers dans la liste des sites de veille sur R : la qualité est hétérogène mais ça informe bien sur les tendances

In GitLab by @oliviermeslin on Jun 23, 2020, 07:38

Je trouve ça bien aussi. Je pense qu'on peut partir sur deux fiches séparées: comment chercher de la documentation, et comment résoudre un problème. Ce sont deux tâches bien distinctes (même si parfois elles se rejoignent...).

Il faut juste que tu te coordonnes avec @mathias.andre qui rédige actuellement une fiche sur comment se former en R. J'imagine par ailleurs que @RLesur aura beaucoup d'idées pour compléter.

In GitLab by @gillesfidani on Jun 23, 2020, 08:27

J'aime bien ce plan. Quelques propositions :

fonctions apropos et ?? (alias de help.search ?)
les livres / documents pédagogiques de la communauté (cf liste https://github.com/frrrenchies/frrrenchies)
Slack grrrrr (toujours actif ?) https://r-grrr.slack.com/#/

In GitLab by @RLesur on Jun 23, 2020, 09:00

Je trouve les 2 parties très pertinentes.

Dans la seconde partie, je suis un peu gêné par l'articulation des points 2.2, 2.3 et 2.4 : je comprends tout à fait le "réflexe" concentrique (qui est lié à un principe de proximité), cependant je crains que ça puisse donner lieu, dans certains cas, à des pratiques non standards.
En effet, il y a un risque pour que se créent des bulles de pratique (une bulle de pratiques "SSP", une bulle de pratiques "francophones", etc.) alors qu'au niveau international, une certaine norme s'est mise en place. Par exemple, on croise encore souvent dans le SSP rm(list = ls()) alors que ça commence à faire quelques années que c'est considéré comme une très mauvaise pratique au niveau international.

Par ailleurs, je rajouterais volontiers un angle "communautaire" pour expliquer que les utilisateurs de R forment une communauté.

J'aurais donc tendance à inverser l'ordre des points :

R est une communauté mondiale, comment la trouver ? comment participer ? dire qu'on trouve tout le monde sur Twitter (hashtag #rstats), mentionner les différentes sous communautés comme R Ladies, etc. parler de rOpenSci (blog, leur slack), RStudio Community, SO et GitHub, parler de la communauté des statisticiens publics (conférence uRos), conférence eRum, conférence useR
il existe une communauté francophone, comment la trouver ? comment participer ? sur Twitter également (hashtag #rstatsFr), la page frrrenchies (https://frrrenchies.github.io/frrrenchies/). Et évidemment le slack grrr (c'est devenu le point de ralliement de toute la communauté :flag_fr:), tout le monde est dessus maintenant. Parler des Rencontres R. Parler des meetups organisés en France (meetups R et meetups R Ladies)
au sein de la sphère publique, le salon Tchap Langage R, spyrales
et enfin, je terminerais par le SSP où la communauté n'est pas encore très structurée et l'Insee (rocket chat)

L'idée c'est qu'on a beaucoup plus de chance de trouver de l'aide dans des communautés à taille respectable (par exemple, sur grrr, SO ou RS Community, on est quasi certain d'avoir une réponse dans la demi journée).

In GitLab by @sylvain.daubree on Jun 23, 2020, 09:48

Merci pour ton commentaire, et tous les ajouts, il y avait des oublis de ma part et des tas de choses que je ne connaissais pas, je vais découvrir plein de choses dans cette fiche ! Par rapport à l'inversion de la pyramide, ton approche est tout à fait celle que j'adopte personnellement, on regarde d'abord largement, là où on a la plus grosse masse critique de contributeurs, le plus de réactivité, et si on a des problèmes spécifiques Insee on passe sur les salons "locaux". Cependant, de mon expérience de formateur, pour la grande majorité de mes stagiaires en direction régionale 1/ ils ne parlent pas anglais 2/ ils ne sont pas à l'aise avec le net de manière générale, les forums, même les chats (d'où d'ailleurs l'importance à mes yeux d'utilitR). C'est pour ça que j'ai plutôt ordonné les choses comme ça, avec une progression "du débutant à l'expert" en gros, même si je suis d'accord que pour un utilisateur avancé, son approche sera plutôt inverse. Bon après, comme sur toutes les questions de plan, on n'est pas obligé de trancher maintenant.

In GitLab by @sylvain.daubree on Jul 22, 2020, 07:53

hello,

Bon j'arrive à une V0.1 du sujet. Je ne suis pas tout à fait satisfait mais je n'aurais pas le temps de faire davantage avant un bon moment, donc si quelqu'un se sent de prendre la main, ou simplement de continuer là-dessus, allez y gaiement ! Je n'ai en particulier pas intégré toutes les propositions que vous avez faites (dans la fiche sur l'aide je suis assez sélectif sur ce que je propose, avec l'idée de ne pas noyer l'utilisateur mais ce choix est tout à fait discutable). J'aime beaucoup l'idée de "hiérarchie des communautés" de @RLesur (à part l'ordre sur lequel nous divergeons :)) , mais je n'ai pas tout intégré simplement parce que je ne connais pas assez pour en parler, mais si lui ou un autre peut compléter je pense que ce serait chouette.

Voilà, en résumé c'est vraiment loin d'être abouti, mais c'est comme ça qu'on avance, donc à vous !

In GitLab by @RLesur on Jul 22, 2020, 08:56

le slack grrr est toujours actif avec plus de 740 membres francophones (le lien d'invitation ayant régulièrement des soucis, il est mis à jour sur frrrenchies).

In GitLab by @RLesur on Jul 22, 2020, 08:58

peux tu référencer la branche ou la merge request ici pour qu'on sache facilement où travailler ?

In GitLab by @sylvain.daubree on Jul 22, 2020, 11:21

oui pardon voilà la branche : https://gitlab.com/linogaliana/documentationR/-/tree/fiche_se_documenter Est-ce qu'il faut déjà que je fasse une merge request ou est-ce trop tôt ?

In GitLab by @RLesur on Jul 22, 2020, 16:16

Merci ! c'est comme tu veux (du moment qu'on a la branche, c'est bon)

InseeFrLab / utilitR

Fiche : comment se documenter sous R #74