Nápověda

→ help je adresář obsahující nápovědu ke všem funkcím, které jsou v daném balíku. Jde o speciální soubory s příponou .Rd. Tento typ souborů má podobný syntax jako LaTeX:

Uvnitř souboru s nápovědou k funkcím to vypadá takhle:

 name{name} Název souboru nápovědy (obvykle stejný jako název funkce)

 alias{topic} Různá slova, která vedou k nápovědě, pokud je uživatel zapíše za „?“ (zahrnuje název funkce)

 title{Title} Delší název/krátký popis – 1 řádek, začíná velkým písmenem bez tečky na konci

 description{. . . } Několik řádků – odstavec – popisujíci funkci

 usage{fun(arg1, arg2, . . . )} Syntax, jakým se funkce volá spolu s argumenty

 arguments{. . . }“ Popis každého argumentu

 details{. . . } Detailní popis toho, co funkce dělá, případně jednotlivých proměnných a jejich použití, popis metod, návod pro nastavení argumentů...

 value{. . .} Popis výstupní hodnoty. Pokud je to list, popis každého elementu.

 references{. . .} Reference. Pro webové adresy se používa url{}

 author{. . .} Autor nápovědy. Použijte email{} pro emailové adresy, url{} pro webové adresy

 note{. . .} Poznámka

 seealso{. . .} další R funkce/objekty spojené s touto funkcí. Specifikuje se pomocí code{link{...}}.

 examples{. . .} Príklady použití funkce. Měly by být jednoduché a výpočet krátký.

 keyword{key} Klíčová slova.  

Uvnitř souboru s nápovědou k datovým souborům to vypadá takhle:

 name{name} Název datového objektu

 docType{data} Vždy data

 alias{topic} To samé jako u funkce

 title{Title} Delší název datového objektu - 1 řádek

 description{. . . } Několik řádků popisu

 usage{name} jak se načítají, např. data(name)

 format{. . . }  Formát objektu – list či datový soubor, pokud je to list, popis každého elementu

 source{. . . } Info o originálním zdroji dat, pro webové adresy použít url{}

 references{. . . } Reference

 examples{. . . } Příklady použití (načítání, zobrazení, graf...)

 keyword{datasets} Vždy datasets

   Uvnitř souboru s nápovědou k balíkům to vypadá takhle:

name{name} název souboru nápovědy

alias{topic} To samé jako u funkce

docType{package} Vždy package

title{Title}

description{. . . }

author{. . . } Autor/autoři

references{. . . } Reference k dalším zdrojům

keyword{package} Vždy package

seealso{. . . } další R funkce/objekty spojené s touto funkcí. Specifikuje se pomocí code{link[<pkg>:<pkg-package]{<pkg>}}

examples{. . . } Jednoduché příklady použití nejdůležitějších funkcí