Kapitel 7 Die Hilfe

Wir haben bereits Seiten wie rdrr.io und rdocumentation.org erwähnt, wo ihr euch Dokumentation anschauen könnt. Unter Dokumentation verbirgt sich übrigens nichts weltbewegendes, in der Regel geht es nur darum wie einzelne Funktionen zu benutzen sind. Diese Seiten sind im Wesentlichen aufgebohrte Versionen der Hilfe, die R von Haus aus mtibringt — allerdings mit bells & whistles in Form von schönerer Optik, erweiterter Suchfunktion, Verlinkungen etc.

Diie Hilfe findet ihr auf der rechten Seite in RStudio, unter dem "Help"-Tab:

Die Startseite der R-Hilfe

Abbildung 7.1: Die Startseite der R-Hilfe

In die Suchleiste oben rechts könnt ihr Suchbegriffe eingeben. Denkt daran, dass die Hilfe in erster Linie auf englisch verfügbar ist.

7.1 Format

Die Dokumentation von Funktionen hat immer das gleiche Format mit bestimmtem Pflichtbereichen und mehreren optionalen Abschnitten.

  • Description: Was macht die Funktion?
  • Usage: Wie benutzt man die Funktion?
  • Value: Was kommt dabei raus?
  • See Also: Welche anderen Funktionen sind verwandt?
  • Examples: Anwendungsbeispiele

7.2 Sprache

Die R-Hilfe ist primär auf englisch verfügbar.
Wenn euch das überrascht, dann geht mal vor die Tür.
Zusätzlich ist die Hilfe meistens von den AutorInnen der jeweiligen Packages/Funktionen geschrieben, was zwar den Vorteil hat, dass sie in der Regel zumindest inhaltlich korrekt ist, aber für Laien manchmal nur so mäßig verständlich ist, was da jetzt eigentlich genau gesagt wird.

Häufig werden Begriffe verwendet, die für euch womöglich eher fremd erscheinen, weil ihr vermutlich keinen Hintergrund in der Programmierung / Numerik / whatever habt, aber keine Angst. Früher oder später lernt ihr die Begriffe, die relevant sind, und wenn ihr mal was so gar nicht versteht, dann fragt ihr eben einfach bei TutorInnen nach, googlet den Quatsch, oder ignoriert es einfach und versucht halt so weiter zu kommen.