Helpbestanden met R-pakketten

R-pakketten ontwikkelen

Jasmin Ludolf

Content Developer

Structuur van een R-pakket

Voorbeeld van pakketsstructuur

R-pakketten ontwikkelen

Helpbestanden voor functies

Volgorde van helpbestand-onderdelen

  • Titel
  • Beschrijving

use_package-hulp

R-pakketten ontwikkelen

Helpbestanden voor functies

Volgorde van helpbestand-onderdelen

  • Titel
  • Beschrijving
  • Gebruik
  • Argumenten

use_package-hulp

R-pakketten ontwikkelen

Helpbestanden voor functies

Volgorde van helpbestand-onderdelen

  • Titel
  • Beschrijving
  • Gebruik
  • Argumenten
  • Retourneert en/of Zie ook
  • Voorbeelden

use_package-hulp

R-pakketten ontwikkelen

roxygen2-koppen voor Title en Description

  • Koptekst na #' verschijnt boven de functiedefinitie

 

#' Afhankelijk zijn van een ander pakket
#'

#' `use_package()` voegt een CRAN-pakketafhankelijkheid toe aan `DESCRIPTION` en
#' geeft kort advies over het beste gebruik. `use_dev_package()` voegt een
#' afhankelijkheid toe van een pakket in ontwikkeling en zet de dev-repo in
#' `Remotes`, zodat het automatisch vanaf de juiste locatie wordt geïnstalleerd.
R-pakketten ontwikkelen

Gebruik en roxygen2-kop voor Arguments

use_package(package, type = "Imports", min_version = NULL)

#' @param package Naam van het pakket waarvan je afhankelijk bent.
#' @param type Type afhankelijkheid: een van "Imports", "Depends",
#'   "Suggests", "Enhances" of "LinkingTo" (of unieke afkorting). Hoofd-/kleine
#'   letters maken niet uit.

#' @param min_version Optioneel: minimale pakketversie.
#'   Zet op `TRUE` om de momenteel geïnstalleerde versie te gebruiken.

#' @param remote Standaard wordt een `OWNER/REPO` GitHub-remote ingevoegd.
#'   Je kunt ook een tekenreeks opgeven voor de remote, bijv.
#'   `"gitlab::jimhester/covr"`, met elke syntaxis die wordt ondersteund door het
#'   [remotes-pakket](
#'   https://remotes.r-lib.org/articles/dependencies.html#other-sources).
R-pakketten ontwikkelen

roxygen2-koppen voor Returns en See Also

Uit unitConverter:

#' @returns Een numerieke temperatuurwaarde in de eenheid gespecificeerd als `unit_to`.

Uit use_this:

#' @seealso De [Dependencies-
#'   sectie](https://r-pkgs.org/description.html#dependencies) van [R
#'   Packages](https://r-pkgs.org).
#'
R-pakketten ontwikkelen

Geëxporteerde vs. niet-geëxporteerde functies

Geëxporteerde functies:

  • Geladen met het pakket
  • Roep use_packag() direct na de library()-aanroep aan
  • Gedocumenteerd in helpbestanden
  • Kernfunctionaliteit van het pakket

 

Niet-geëxporteerde functies:

  • Aangeroepen met :::
  • Mogen gedocumenteerd zijn
  • Ondersteunen geëxporteerde functies
R-pakketten ontwikkelen

Hoe exporteer je een functie

  • Standaard worden functies niet geëxporteerd
  • Eerder: unitConverter:::temp_converter()

 

#' @export
R-pakketten ontwikkelen

Voorbeelden

#' @examples
#' \dontrun{
#' use_package("ggplot2")
#' use_package("dplyr", "suggests")
#' use_dev_package("glue")
#' }
R-pakketten ontwikkelen

Laten we oefenen!

R-pakketten ontwikkelen

Preparing Video For Download...