Passi finali

Sviluppare pacchetti R

Jasmin Ludolf

Content Developer

Struttura di un pacchetto R

Scheletro pacchetto R

Versioni del pacchetto

Esempio: tidyr 1.3.0

Formato: <major>.<minor>.<patch>.<dev>
Predefinito: 0.0.0.9000
9000: pacchetto in sviluppo

Linee guida per incrementare la versione

Formato: <major>.<minor>.<patch>.<dev>

dev: raramente cambiato, rimuovere per il rilascio
patch: cambia per correzioni di bug
- Più bug prima di cambiare funzionalità
minor: piccola funzionalità aggiunta prima del primo rilascio
- Numero patch reimpostato a 0
major: pacchetto stabile per il rilascio
- Da 1.5.3 a 2.0.0: vecchio codice potrebbe rompersi

Non in sviluppo: 0.0.0.9000 -> 0.0.0
Un bug corretto: 0.0.1
Un altro bug corretto: 0.0.2
Funzionalità aggiunta: 0.1.0

Stabile per rilascio: 1.0.0
Grandi cambiamenti: 2.0.0

Aggiorna titolo, autore, versione e descrizione

Package: unitConverter
Title: What the Package Does (One Line, Title Case)

Version: 0.0.0.9000

Authors@R: 
    person("First", "Last", , 
           "[email protected]", 
           role = c("aut", "cre"),
           comment = c(ORCID = "YOUR-ORCID-ID"))

Description: What the package does (one paragraph).

Package: unitConverter
Title: Unit Conversion Utilities for Distance, 
    Time, Weight, and Temperature

Version: 0.1.0

Authors@R: 
    person("Jasmin", "Ludolf", , 
           "[email protected]", 
           role = c("aut", "cre"))

Description: The `unitConverter` package provides 
    a collection of utility functions for 
    converting distance, time, weight, and 
    temperature values. It offers seamless 
    conversion between various units within each     
    category, allowing users to easily transform     
    measurement data.

Documentare un file di dati

use_r("temperature_data")

Modifica R/temperature_data.R:

#' Valori e unità di temperatura
#'

#' Valori di temperatura e unità corrispondente (Celsius, Fahrenheit o Kelvin)

#' @format Data frame con due colonne e 1000 righe

#' \describe{
#' \item{value}{Valore numerico della temperatura.}
#' \item{unit}{Unità di temperatura.}
#' }

#' @examples
#'   temperature_data

"temperature_data"

roxygenize()

Cosa controlla devtools::check()?

devtools::check()

Il pacchetto si installa?
Info in DESCRIPTION corrette
Dipendenze del pacchetto
Errori di sintassi nel codice
Documentazione completa
Test eseguiti con successo
Vignette costruite con successo

Segno di spunta

Esecuzione di devtools::check()

GIF controllo unitConverter

Passons à la pratique !

Sviluppare pacchetti R