Lägga till hjälpsidor

Om du vill skriva en hjälpsida för insticksprogrammet, är det mest rättframma sättet att göra det att direkt lägga till de specifika instruktionerna i definitionen av XML-elementen de hör till:

variables <- rk.XML.varselector(
  id.name="vars",
  help="Select the data object you would like to analyse.",
  component="Data"
)
    

Texten som ges till parametern help kan då hämtas av rk.rkh.scan() och skrivas till hjälpsidan för den komponenten i insticksprogrammet. För att det ska fungera tekniskt, måste dock rk.rkh.scan() veta vilka R-objekt som hör till en komponenten i insticksprogrammet. Det är orsaken till att du också måste tillhandahålla parametern component, och se till att den är identisk för alla objekt som hör ihop.

Eftersom du oftast kombinerar många objekt i en dialogruta, och också kan vilja återanvända objekt som <varslot> för flera komponenter i dina insticksprogram, är det möjligt att definiera en komponent globalt med rk.set.comp(). Om det är gjort, antas att alla följande objekt som används i skriptet hör till den specifika komponent, tills rk.set.comp() anropas igen med ett annat komponentnamn. Då kan parametern component utelämnas:

rk.set.comp("Data")
variables <- rk.XML.varselector(
  id.name="vars",
  help="Select the data object you would like to analyse."
)
    

För att lägga till allmänna sektioner som <summary> eller <usage> på hjälpsidan, används funktioner som rk.rkh.summary() eller rk.rkh.usage(). Deras resultat används sedan för att ange listelement som summary eller usage i parametern rkh för rk.plugin.component() och rk.plugin.skeleton().