Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structure du site #45

Closed
larmarange opened this issue Jul 5, 2015 · 31 comments
Closed

Structure du site #45

larmarange opened this issue Jul 5, 2015 · 31 comments

Comments

@larmarange
Copy link
Owner

Discussion de la structure du site

En lien avec le wiki https://github.com/larmarange/analyse-R/wiki/Structure-du-texte

@larmarange
Copy link
Owner Author

Je me demande si on ne pourrait revoir la structure du site avec trois grandes entrées : Manipuler, Analyser, Approfondir

Le site serait alors divisé ainsi :

Manipuler

  • Prise en main
    • Présentation et Installation
    • Premier contact
    • Premier travail avec les données
    • Organiser ses fichiers
    • Import/Export de données
    • Variables
    • Indexation
    • Recodages
    • Exporter des graphiques
    • Où trouver de l'aide ?
  • Manipulation des données (intermédiare)
    • Introduction à dplyr
    • Introduction à data.table
    • Doublons et valeurs uniques
    • Tris
    • Sous-populations
    • Fusion de tables
  • Manipulation des données (avancé)
    • Aggrégation
    • Fonctions à fenêtre
    • Remodelage des données (reshape...)
    • Manipulation du texte (stringr, stringi)
    • Bases de données SQL
    • récupération de données web

NB : les chapitres de la sous-section Manipulation des données présenteraient à la fois, pour chaque type de problème, R base, dplyr, data.table.

Analyser

  • Statistiques introductives
  • Statistiques intermédiaires
  • Statisques avancées

Aprofondir

  • Programmation
    • Formules ou la notation "équation"
    • Structures conditionnelles
    • Expressions régulières
    • Ecrire ses propres fonctions
    • Shiny et les interfaces interactives
    • Lubridate et la gestion des dates
    • RStudio et Git
    • Ecrire un package
  • Graphiques
    • ggplot2 avancé
    • diagrammes
    • représenter des flux
    • réseaux dynamiques
    • ggvis et les graphiques interactifs
  • Exemples d'analyse
    • ....
  • Astuces
    • Calculer un âge
    • ...

Il y aurait donc du débutant et de l'avancé dans chaque section.

On indiquerai en page d'accueil que pour ceux débutant avec R, on les invite à lire en tout premier lieu la sous-section Prise en main de Manipuler puis la sous-section Statistiques introductives de la section Analyser.

@larmarange
Copy link
Owner Author

@briatte

En un sens, cela amène une structure globale systématiquement en sections et sous-sections. Avec trois grandes entrées indiquées par des verbes ce qui fait qqch de plus dynamique.

Dans la foulée, je supprimerai bien le bouton Accueil car il fait doublon dans le menu avec analyse-R qui renvoie aussi vers l'accueil.

Je regrouperai bien les index et le PDF sous une même entrée Naviguer ou Chercher. Ou pourrait même y déplacer le chapitre Où trouver de l'aide ?.

Enfin, il y aurait assez de place pour ramener Participer dans le menu principal. Est-ce que le terme Contribuer serait plus approprié ? On pourrait rajouter une page expliquant les différentes manières de participer (forums, indiquer les bugs et les coquilles, proposer des chapitres, etc.)

@larmarange larmarange changed the title Section Prise en main Structure du site Jul 5, 2015
@briatte
Copy link
Collaborator

briatte commented Jul 5, 2015

Comme je viens juste de découvrir la structure actuelle, j'ai du mal à me projeter dans une autre. Celle-ci me semble plus difficile d'accès.

Dans la foulée, je supprimerai bien le bouton Accueil car il fait doublon dans le menu avec analyse-R qui renvoie aussi vers l'accueil.

OK.

Enfin, il y aurait assez de place pour ramener Participer dans le menu principal. Est-ce que le terme Contribuer serait plus approprié ? On pourrait rajouter une page expliquant les différentes manières de participer (forums, indiquer les bugs et les coquilles, proposer des chapitres, etc.)

"Contribuer" plutôt que "Participer" : 👍

Ramener dans le menu principal : personnellement, je le trouve bien tout à droite. En revanche, le sous-menu n'est pas utile : un lien simple vers GitHub suffirait, sauf si tu veux rajouter une page "Comment aider", ce qui peut être une bonne idée.

@larmarange
Copy link
Owner Author

Je viens de regarder rapidement la table des matières de R Cookbook, R for everyone et R in action. Tout ce qui est manipulation de données (y compris avancée) est présenté avant l'analyse.

La difficulté est de concilier utilisateur débutant et utilisateur avancé. Mais il ne me semble pas problématique que l'ordre d'un cours ne soit pas forcément l'ordre d'un manuel.

Je vais laisser passer la nuit et j'essaie de préparer une réorga du site demain soir.

@briatte
Copy link
Collaborator

briatte commented Jul 6, 2015

Je suis fan des mêmes bouquins que toi, mais comme tu dis, la difficulté est de rendre le texte utile pour tout le monde. Je serais d'avis d'organiser le texte pour des débutants, et de laisser les utilisateurs avancés se débrouiller pour trouver ce qui les intéresse — dans les sections Analyse et Extras, principalement.

@larmarange
Copy link
Owner Author

Tout ce qui est du domaine de la manipulation de données est centrale et n'a pas sa place en tant que tel dans la section Analyses. Il faut une section dédiée.

Toute la partie prise en main relève soit de la manipulation du logiciel, soit de la manipulation des données.

Pour un débutant, l'ordre "chronologique" serait de l'ordre:

  • prise en main de l'outil et manipulations de bases
  • statistiques introductives
  • manipulation de données intermédiaires
  • statistiques intermédiaires
  • manipulation de données avancées
  • statistiques avancées
  • approfondissements

Dans le cadre d'un cours, on fait la navette entre les deux. C'est justement l'idée d'une structuration en sections et sous-sections. Deux grands pôles Manipuler / Analyser et à chaque fois une progression intro / intermédiaire / avancé

@larmarange
Copy link
Owner Author

Une alternatie pourrait être une structuration en

  • Débutant
    • Prise en main
    • Statistiques introductives
  • Intermédiaire
    • Manipulation de données
    • Statistiques intermédiaires
    • Programmation intermédiaire
  • Avancé
    • Manipulation de données
    • Statistiques avancées
    • Programmation avancée
    • Graphiques
  • Divers
    • Astuces
    • Exemples d'analyse

@larmarange
Copy link
Owner Author

J'ai un peu discuté avec différents collègues ce matin pour avour un feedback un peu extérieur.

Dans ce qu'il en ressort, c'est tout d'abord que lorsqu'on arrive sur un tel site avec un besoin donné il est préférabe d'avoir une aborescence thématique qui répond à la question Qu'est ce que je veux faire ?. Dès lors une structuration de premier niveau du type Débutant / Intermédiaire / Avancé ne serait pas pertinente car on ne saurait pas a priori ce qui appartiendra à chaque niveau. L'approche Manipuler / Analyser / Approfondir s'avère ici plus pertinente.

Par contre, il faut également fournir un parcours facile à suivre pour quelqu'un qui découvre tout juste R. Cela peut se faire à la fois avec des intitulés de sous-sections explicites et avec, en page d'accueil, un parcours proposé aux personnes qui débutent avec R.

@larmarange
Copy link
Owner Author

Voilà, j'ai repris en détail la page https://github.com/larmarange/analyse-R/wiki/Structure-du-texte

Je me lance dans la restructuration des fichiers dans la soirée.

@briatte
Copy link
Collaborator

briatte commented Jul 6, 2015

J'ai lu le wiki, ça a l'air bien !

@larmarange
Copy link
Owner Author

OK.

Je viens d'envoyer un gros lot de commits. La nouvelle structure du site est en place. J'en ai profité pour créer de nombreux chapitres vides (avec un warning). Mais comme ça la structure est en place et on peut déjà faire des liens internes lors de l'écriture.

Ce fut d'ailleurs une bonne idée car cela m'a permis de voir qu'il fallait réorganiser les menus (qui sont maintenant sur 3 colonnes). J'en ai aussi profité pour générer programmatiquement le menu de la page d'accueil.

Sur la page d'accueil, un parcours de lecture est proposé aux débutants.

J'ai aussi réorganisé les préfixes des fichiers et le rangement des figures créées par knitr en dossiers et sous-dossiers. ATTENTION : les captures d'écran doivent rester à la racine de images/ car images/manipuler, images/analyser et images/approfondir sont supprimés par le script Makefile avant d'être regénérés.

@briatte
Copy link
Collaborator

briatte commented Jul 7, 2015

Looks good!

Le PDF est trop difficile à trouver ; je serais d'avis de pousser "Contribuer" à droite comme avant (avec une petit icône GitHub ?), et de mettre un lien direct "Télécharger (PDF)" (ou "Télécharger" avec une icône PDF ?) vers le PDF à la place.

"Naviguer" pourrait s'appeler "Index".

La ligne "Accueil … Développement … analyse-R en PDF" me paraît redondante avec les menus. N'indiquer que la licence suffirait.

Est-ce qu'il y a moyen, dans les menus déroulants, de montrer l'état d'avancement des chapitres, pour distinguer ce qui est déjà rédigé du reste ?

@larmarange
Copy link
Owner Author

Est-ce qu'il y a moyen, dans les menus déroulants, de montrer l'état d'avancement des chapitres, pour distinguer ce qui est déjà rédigé du reste ?

Tu penses à quel type de visuel ? Fond coloré uniquement ou plus ?

@briatte
Copy link
Collaborator

briatte commented Jul 7, 2015

Un fond coloré suffirait à repérer ce qui est déjà lisible.

@larmarange
Copy link
Owner Author

Le PDF est trop difficile à trouver ; je serais d'avis de pousser "Contribuer" à droite comme avant (avec une petit icône GitHub ?), et de mettre un lien direct "Télécharger (PDF)" (ou "Télécharger" avec une icône PDF ?) vers le PDF à la place.

Une première remarque générale, le site responsive, donc il faut penser à regarder ce que ça donne quand on redimensionne la largeur. ;-)

Quitte à pousser à droite, pourquoi ne pas mettre directement un GitHub Ribbons cf. https://github.com/blog/273-github-ribbons que l'on masquerai sur petit écran ?

Il faut essayer de garder un peu de place pour pouvoir rajouter un champs de recherche.

Pour le PDF, est-ce que juste le texte PDF n'est pas suffisant ?

@briatte
Copy link
Collaborator

briatte commented Jul 7, 2015

Ribbon : ça me va.

"PDF" suffirait, oui.

@larmarange
Copy link
Owner Author

OK

je viens de committer les modifs demandées

@briatte
Copy link
Collaborator

briatte commented Jul 7, 2015

"Exporter des graphiques" est en double

  • chapitre dans la partie "PEM"
  • sous-chapitre dans "stats. intro. > graphes univ."

Lequel te paraît le plus approprié ?

@larmarange
Copy link
Owner Author

A mon sens, il est préférable que ca apparisse en clair dans le menu, donc dans PEM. Il suffit de faire un renvoi dans graph univ. (au besoin on peut garder 3-4 lignes dans graph_univ, puisque la redite n'est pas un souci)

@briatte
Copy link
Collaborator

briatte commented Jul 7, 2015

Je comprends, mais en même temps, aucune section avant "Exporter des graphiques" ne produit de graphiques, non ?

@larmarange
Copy link
Owner Author

Il suffit de déplacer au début de manipulation de données (intermédiaires) ?

Joseph

2015-07-07 22:36 GMT+02:00 François notifications@github.com:

Je comprends, mais en même temps, aucune section avant "Exporter des
graphiques" ne produit de graphiques, non ?


Reply to this email directly or view it on GitHub
#45 (comment)
.

@larmarange
Copy link
Owner Author

Et dans graph univarié juste aborder le bouton exporter de RStudio, sans rentrer dans les détails sur le type d'images

@briatte
Copy link
Collaborator

briatte commented Jul 7, 2015

Il suffit de déplacer au début de manipulation de données (intermédiaires) ?

C'est pas vraiment intermédiaire, sauf si on fait un truc complet en expliquant aussi comment paramétrer les dimensions et la résolution des graphiques.

À la rigueur, je dirais : à la toute fin de "stats. intro.", en rajoutant aussi un chapitre sur "Exporter des tableaux", ce qui serait très utile, au passage.

J'aurais également tendance à placer "Interv. de confiance" et "Comp. de moyennes/props" dans "Stats. intro.", après "Données pondérées".

@larmarange
Copy link
Owner Author

Je suis d'accord pour intervalles de confiance et comparaisons.

Pour ce qui est des exports de graphiques et de tableaux, cela relève
clairement de Manipuler et pas d'Analyser. Il faut que ces informations
soient accessibles dans le cadre des entrées thématiques ce qui n'empêche
pas que cela puisse aussi être présenté (plus succinctement) dans les
chapitres analytiques correspondants (tout comme il y a des graphiques dans
stats univariées même si c'est complété ensuite dans un chapitre plus
important).

Faudrait-il une sous-section supplémentaire Exporter dans Manipuler, avec
Exports de données, Export de graphiques, Export de tableaux ?

Joseph

Le 7 juillet 2015 22:50, François notifications@github.com a écrit :

Il suffit de déplacer au début de manipulation de données (intermédiaires)
?

C'est pas vraiment intermédiaire, sauf si on fait un truc complet en
expliquant aussi comment paramétrer les dimensions et la résolution des
graphiques.

À la rigueur, je dirais : à la toute fin de "stats. intro.", en rajoutant
aussi un chapitre sur "Exporter des tableaux", ce qui serait très utile, au
passage.

J'aurais également tendance à placer "Interv. de confiance" et "Comp. de
moyennes/props" dans "Stats. intro.", après "Données pondérées".


Reply to this email directly or view it on GitHub
#45 (comment)
.

@briatte
Copy link
Collaborator

briatte commented Jul 8, 2015

Ce serait une bonne idée ! J'exporte tout avec xtable mais je sais que ce n'est pas la seule solution.

@larmarange
Copy link
Owner Author

Juste pour simplifier (et éviter d'avoir 4 sections dans Manipuler), que
dirais-tu de :

  • fusionner Manipulation de données intermédiaires et avancées

  • créer une troisième section Exporter

    Joseph

2015-07-08 13:48 GMT+02:00 François notifications@github.com:

Ce serait une bonne idée ! J'exporte tout avec xtable mais je sais que ce
n'est pas la seule solution.


Reply to this email directly or view it on GitHub
#45 (comment)
.

@briatte
Copy link
Collaborator

briatte commented Jul 10, 2015

Ça me va !

@larmarange
Copy link
Owner Author

section exporter crée. Je te laisse faire le renommage des fichiers et le js du menu quand tu pourras

@larmarange
Copy link
Owner Author

Je viens de procéder au renommage des fichiers. Au passage, plus besoin de préciser le répertoires des graphiques (c'est auto). Et le menu fonctionne

@briatte
Copy link
Collaborator

briatte commented Jul 12, 2015

Nickel !

@larmarange
Copy link
Owner Author

Pour info, je viens de procéder à une réorga de la partie prise en main, suite à des sessions de formation que j'ai réalisée en Afrique du Sud. Un peu moins de technique dans premier travail avec les données, mais ajout de quelques calculs et graphiques simples pour mieux voir les possibilités de R. Puis 3 chapitres qui reprennent les objets de base et l'indexation. Il me reste la partie Recodage à compléter et la section Prise en main devrait être complète.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants