Chapitre 4. R et sa documentation
155
Voici les diff´ erentes sections de ce fichier d’aide :
x L’en-tˆ ete du fichier contenant :
– le nom de la fonction pour laquelle on recherche de l’aide : mean ;
– le nom du package qui contient cette fonction : base ;
– l’origine du fichier d’aide : R Documentation.
y Un titre explicite pour la fonction : Arithmetic Mean.
z Une br` eve description de ce que fait la fonction : Description.
{ La fa¸ con d’utiliser la fonction avec notamment ses param` etres obligatoires et optionnels : Usage.
| Une description des diff´ erents param` etres d’entr´ ee de la fonction :
Arguments.
} Des explications sur ce que renvoie la fonction lorsqu’elle est ex´ ecut´ ee :
Value.
~ Des r´ ef´ erences d’articles ou d’ouvrages ayant rapport avec le domaine
statistique d’application de la fonction : References.
La rubrique See Also qui donne le nom de fonctions similaires ou en
rapport avec la fonction en cours d’investigation.
Des exemples montrant comment utiliser cette fonction : Examples.
Attention
La plupart des fichiers d’aide ont le mˆ eme format. Vous devez bien
comprendre et retenir la logique organisationnelle de la structure des diff´ erents fichiers d’aide. Vous devez aussi prendre l’habitude d’utiliser l’aide en
ligne d` es que vous rencontrez une nouvelle fonction inconnue afin de bien
comprendre quels sont ses param` etres et comment elle s’utilise.
Astuce
Vous noterez que tous ces fichiers d’aide ne contiennent pas de graphiques ` a visualiser, notamment ceux qui pourraient ˆ etre produits par le
code de la section Examples . Cela pourrait toutefois ˆ etre int´ eressant, en
particulier pour toutes les fonctions graphiques. Une fa¸ con de les obtenir
consiste `
a utiliser la fonction example(). Vous pouvez aussi consulter le site
web R Graphical Manual : http://bm2.genes.nig.ac.jp/RGM2/index.
php qui pr´ esente tous les fichiers d’aide de R au format HTML. Dans ces
fichiers, les graphiques, lorsqu’il y en a, sont directement incorpor´ es dans
la section Examples.
4.1.2 Quelques commandes compl´ ementaires
En plus de la commande principale help(), il existe quelques autres fonctions compl´ ementaires qui peuvent se r´ ev´ eler utiles lorsque l’on cherche de l’aide
155
Voici les diff´ erentes sections de ce fichier d’aide :
x L’en-tˆ ete du fichier contenant :
– le nom de la fonction pour laquelle on recherche de l’aide : mean ;
– le nom du package qui contient cette fonction : base ;
– l’origine du fichier d’aide : R Documentation.
y Un titre explicite pour la fonction : Arithmetic Mean.
z Une br` eve description de ce que fait la fonction : Description.
{ La fa¸ con d’utiliser la fonction avec notamment ses param` etres obligatoires et optionnels : Usage.
| Une description des diff´ erents param` etres d’entr´ ee de la fonction :
Arguments.
} Des explications sur ce que renvoie la fonction lorsqu’elle est ex´ ecut´ ee :
Value.
~ Des r´ ef´ erences d’articles ou d’ouvrages ayant rapport avec le domaine
statistique d’application de la fonction : References.
La rubrique See Also qui donne le nom de fonctions similaires ou en
rapport avec la fonction en cours d’investigation.
Des exemples montrant comment utiliser cette fonction : Examples.
Attention
La plupart des fichiers d’aide ont le mˆ eme format. Vous devez bien
comprendre et retenir la logique organisationnelle de la structure des diff´ erents fichiers d’aide. Vous devez aussi prendre l’habitude d’utiliser l’aide en
ligne d` es que vous rencontrez une nouvelle fonction inconnue afin de bien
comprendre quels sont ses param` etres et comment elle s’utilise.
Astuce
Vous noterez que tous ces fichiers d’aide ne contiennent pas de graphiques ` a visualiser, notamment ceux qui pourraient ˆ etre produits par le
code de la section Examples . Cela pourrait toutefois ˆ etre int´ eressant, en
particulier pour toutes les fonctions graphiques. Une fa¸ con de les obtenir
consiste `
a utiliser la fonction example(). Vous pouvez aussi consulter le site
web R Graphical Manual : http://bm2.genes.nig.ac.jp/RGM2/index.
php qui pr´ esente tous les fichiers d’aide de R au format HTML. Dans ces
fichiers, les graphiques, lorsqu’il y en a, sont directement incorpor´ es dans
la section Examples.
4.1.2 Quelques commandes compl´ ementaires
En plus de la commande principale help(), il existe quelques autres fonctions compl´ ementaires qui peuvent se r´ ev´ eler utiles lorsque l’on cherche de l’aide