Az R nyelv rendkívül jól dokumentált, nemcsak a parancsok jelentését tudjuk megkeresni, hanem a parancsok használatára példákat is láthatunk.
A következőkben bemutatom, hogy milyen segédletek érhetők el az R nyelvhez:
Help
Az R beépített súgórendszere. Akkor érdemes használni, ha részletes információkat szeretnénk kapni egy adott függvényről.
Használata: help(fv_neve) vagy ?fv_neve.
Ha létezik a függvény, amiről információt szeretnénk, akkor egy a Unix manhoz nagyon hasonló segédletet kapunk. A parancs kiadása után a következő szerkezetű lesz az eredmény:
- a keresett objektum neve, a csomag neve ahol található
- a második sorban lesz hogy a dokumentáció melyik szakaszában található
- leíró részek:
- Description: rövid leírása az adott objektumnak
- Usage: függvény esetén annak szintaxisa argumentumaival, operátor esetén annak tipikus alkalmazásának szintaxisa
- Arguments: az argumentumok részletes leírása
- Details: részletesebb leíró rész
- Value: abban az esetben van ilyen rész, ha a függvény operátor használata során keletkezik valamilyen objektum, ennek az ojektumnak a leírása
- References: bibliográfiai adatok
- Author(s): a készítők neve
- See Also: javaslatok, hogy mit érdemes még megnézni a dokumentációban az adott témával kapcsolatban
- Examples: példák, hogy hogyan használjuk a függvényt vagy operátort
Speciális karaktereket vagy szintaktikai jelentéssel bíró kifejezések (pl.: if) esetén írjuk dupla idézőjelek közé a kifejezést: help(”if”).
A help() csak abban az esetben használható, ha pontosan ismerjük a parancs nevét, amiről szeretnénk információt kapni. Ellenkező esetben használhatjuk a ??nev parancsot, ezzel kapunk egy olyan listát, hogy a nev milyen függvények paramétereként szerepel. Az apropos(”nev”) használatával a betöltött könyvtárak objektumainak neveiben kereshetünk. A help.search(”nev”) paranccsal nemcsak a betöltött, hanem az összes telepített csomagban kereshetünk.
Example
Ez a parancs segítségünkre lehet abban, hogy az egyes függvények használatát könnyebben megértsük. A szerzők az egyes függvényekhez példaprogramokat építettek be, hogy az egyes paraméterezéseket szemléltessék. Az example(fuggveny_nev) paranccsal tudjuk ezeket kipróbálni.
Demo
A demo() utasítással ki tudjuk listáztatni, az alapcsomagokhoz megírt szkripteket, amik bemutatják a csomagokhoz tartozó eljárásokat. A listából kiválaszthatjuk, hogy melyik eljáráshoz tartozó bemutatót szeretnénk lefuttatni és a demo(kivalasztott_eljaras) paranccsal lefuttathatjuk a szkriptet.
Amennyiben az összes telepített csomaghoz szeretnénk megnézni, hogy milyen bemutatók vannak, használjuk a demo(package = .packages(all.available = TRUE)) parancsot.