Conventions

À discuter. J'ai notamment modifié (raccourci) les balises servant à indexer les fonctions et les packages, et j'ai passé les noms de variables en code plutôt qu'en italiques.

Code

Pour tout ce qui concerne le style du code R, on peut se fixer comme objectif de suivre le guide de Hadley Wickham : http://adv-r.had.co.nz/Style.html

Éléments de texte

A l'intérieur d'un chapitre, on utilisera des titres de niveau 2 ou inférieur, le niveau h1 étant réservé pour le titre de chapitre.

Ne pas inclure de numérotation.

Typographie

La fonction 'smart punctuation' est limitée pour le français : il importera donc d'insérer en caractères UTF-8 les guillemets français ainsi que les espaces insécables avant les ponctuations.

Nom de logiciel

Le nom sera indiqué en gras.

Exemple :

**Word** a planté

Mot étranger

Le mot sera indiqué en italiques.

Exemple :

le _package_

Packages, fonctions, etc.

Packages R

Le nom sera indiqué en gras, dans une balise strong avec une classe CSS égale à "package".

Exemples :

<strong class="package">questionr</strong>

Fonctions R

Le nom sera indiqué dans une balise <code> ou l'équivalent Markdown (backticks).

Le package dont est issu cette fonction sera précisé dans un attribut "r-pkg". Le cas échéant (pour une méthode par exemple), on précisera dans un attribut "r-doc" le nom utilisé sur http://www.rdocumentation.org

Exemples :

_package_ `freq`{r-pkg="questionr"}

méthode `summary`{r-pkg="prevR" r-doc="summary-prevR-method"}

classe `prevR`{r-pkg="prevR" r-doc="prevR-class"}

Objets, variables, arguments

Balise <code> ou équivalent Markdown (backticks).

Exemples :

l'argument `showWarnings` permet de ...

l'objet `hdv2003` contient ...

la variable `diplome` mesure...

Valeurs manquantes

NA

Encadrés

Les encadrés sont précisés avec une balise <div> et la classe CSS appropriée. Les différentes classes disponibles sont :

• info (bleu)
• note (gris)
• astuce (vert)
• important (jaune)
• attention (rouge)

Figures

Elles doivent être présentées au sein de balises <figure>.

Le titre de la figure est précisé avec une balise <figcaption>.

La numérotation est automatique.

Concepts

Sont indiqués avec <dfn> ... </dfn>. Permettent de produire un index des concepts.

On peut contrôler l'entrée d'index avec

<dfn data-index="package">packages</dfn>

Pour saisir une entrée secondaire, on utilisera un vide

<dfn data-index="entrée secondaire"></dfn>

On utilisera ... pour spécifier une entrée en anglais.