File di help con i pacchetti R

Sviluppare pacchetti R

Jasmin Ludolf

Content Developer

Struttura di un pacchetto R

Struttura esempio di pacchetto

Sviluppare pacchetti R

File di help per le funzioni

Ordine dei componenti del file di help

  • Title
  • Description

help di use_package

Sviluppare pacchetti R

File di help per le funzioni

Ordine dei componenti del file di help

  • Title
  • Description
  • Usage
  • Arguments

help di use_package

Sviluppare pacchetti R

File di help per le funzioni

Ordine dei componenti del file di help

  • Title
  • Description
  • Usage
  • Arguments
  • Returns e/o See Also
  • Examples

help di use_package

Sviluppare pacchetti R

Header roxygen2 per Title e Description

  • Il testo dopo #' appare sopra la definizione della funzione

 

#' Dipendere da un altro pacchetto
#'

#' `use_package()` aggiunge una dipendenza da un pacchetto CRAN a `DESCRIPTION`
#' e offre qualche consiglio su come usarla al meglio. `use_dev_package()`
#' aggiunge una dipendenza da un pacchetto in sviluppo, inserendo il repo di
#' sviluppo in `Remotes` così verrà installato automaticamente dal posto giusto.
Sviluppare pacchetti R

Uso e header roxygen2 per Arguments

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

#' @param package Nome del pacchetto da cui dipendere.
#' @param type Tipo di dipendenza: deve essere uno tra "Imports",
#'   "Depends", "Suggests", "Enhances" o "LinkingTo" (o abbreviazione unica).
#'   Il confronto non distingue maiuscole/minuscole.

#' @param min_version Facoltativo, versione minima richiesta del pacchetto.
#'   Imposta `TRUE` per usare la versione attualmente installata.

#' @param remote Per default viene inserito un remoto GitHub `OWNER/REPO`.
#'   In alternativa, puoi fornire una stringa per specificare il remoto, es.
#'   `"gitlab::jimhester/covr"`, usando qualsiasi sintassi supportata dal
#'   [pacchetto remotes](
#'   https://remotes.r-lib.org/articles/dependencies.html#other-sources).
Sviluppare pacchetti R

Header roxygen2 per Returns e See Also

Da unitConverter:

#' @returns Un valore numerico di temperatura nell'unità indicata in `unit_to`.

Da use_this:

#' @seealso La [sezione sulle dipendenze
#'   ](https://r-pkgs.org/description.html#dependencies) di [R Packages](https://r-pkgs.org).
#'
Sviluppare pacchetti R

Funzioni esportate vs non esportate

Funzioni esportate:

  • Caricate con il pacchetto
  • Chiama use_packag() subito dopo library()
  • Documentate nei file di help
  • Funzionalità core del pacchetto

 

Funzioni non esportate:

  • Chiamate con :::
  • Possono essere documentate
  • Supportano le funzioni esportate
Sviluppare pacchetti R

Come esportare una funzione

  • Per default, le funzioni non sono esportate
  • In precedenza: unitConverter:::temp_converter()

 

#' @export
Sviluppare pacchetti R

Esempi

#' @examples
#' \dontrun{
#' use_package("ggplot2")
#' use_package("dplyr", "suggests")
#' use_dev_package("glue")
#' }
Sviluppare pacchetti R

Ayo berlatih!

Sviluppare pacchetti R

Preparing Video For Download...