Genera uno scheletro di vignetta per un pacchetto R

Hai lavorato a stretto contatto con il tuo team allo sviluppo del pacchetto R unitConverter. Hai aggiunto dati, creato funzioni, documentato quelle funzioni e adottato molte altre pratiche in linea con uno sviluppo di pacchetti di successo. È ora di generare una vignetta per questo pacchetto.

Il pacchetto usethis è già stato caricato per te.

Questo esercizio fa parte del corso

Sviluppare pacchetti R

Visualizza corso

Istruzioni dell'esercizio

Crea una vignetta con nome "dist_conversion" e titolo "Distance Conversion Examples".

esercizio interattivo pratico

Prova questo esercizio completando questo codice di esempio.

# Create vignette
___

Modifica ed esegui il codice

Questo esercizio fa parte del corso

Sviluppare pacchetti R

IntermediárioNível de habilidade

4.8+

Inizia il corso gratuitamente

Entra negli elementi essenziali della costruzione di un pacchetto R: dall’architettura, alle directory fondamentali R e man, fino all’importanza dei file DESCRIPTION e NAMESPACE. Metti subito le mani in pasta con il pacchetto usethis per creare lo scheletro del tuo pacchetto e includere i dati. Rafforza le tue abilità di scrittura di funzioni in R, assimila le buone pratiche per lo sviluppo di pacchetti e prendi confidenza con il salvataggio delle funzioni in un file. Infine, installa localmente il tuo pacchetto usando devtools.

Exercise 1: Componenti di un pacchetto R Exercise 2: Verità sui pacchetti R Exercise 3: Cosa serve in tutti i pacchetti R?Exercise 4: Componenti richiesti del pacchetto Exercise 5: Dati e modello R Markdown in un pacchetto R Exercise 6: Crea un pacchetto R Exercise 7: Aggiungi dati al pacchetto R Exercise 8: Crea un file template R Markdown per un pacchetto R Exercise 9: Struttura del file modello R Markdown Exercise 10: Creare funzioni del pacchetto Exercise 11: Funzione R per convertire le distanze Exercise 12: Installa il pacchetto R e provalo

Scopri i vantaggi di creare pacchetti rispetto all’uso di script, esplorando l’impatto su organizzazione del codice, riproducibilità, collaborazione e condivisione. Individua strategie efficaci per strutturare codice e funzioni nella directory R e per scegliere un nome e una licenza adeguati per il tuo pacchetto. Infine, imparerai a gestire le dipendenze dai pacchetti CRAN.

Exercise 1: Altre strutture del pacchetto Exercise 2: Confrontare pacchetti e script Exercise 3: Controllare il nome del tuo pacchetto Exercise 4: Scegliere una licenza appropriata per il tuo pacchetto Exercise 5: Build del pacchetto Exercise 6: Aggiungere e testare una nuova funzione nel pacchetto Exercise 7: Esegui il debug degli errori con load_all()Exercise 8: Differenze tra errori, avvisi e note di check()Exercise 9: Dipendenze del pacchetto Exercise 10: Tipi di dipendenze dei pacchetti R Exercise 11: Imposta le dipendenze del pacchetto Exercise 12: Imposta altre dipendenze del pacchetto

Sfrutta la forza degli esempi nella documentazione creando esempi di funzioni con roxygen2. Comprendi l’importanza degli esempi per chiarire il comportamento delle funzioni e identifica gli elementi chiave di una funzione R ben documentata. Esplora lo scopo delle vignette nella documentazione dei pacchetti R e apprendi le buone pratiche per creare vignette coinvolgenti e valutarne contenuti e qualità tramite l’analisi dei metadati.

Exercise 1: File di help con i pacchetti R Exercise 2: Ordine dei componenti del file di help Exercise 3: Funzioni esportate e non esportate Exercise 4: Documentazione con roxygen2 Exercise 5: Avvii per la documentazione delle funzioni Exercise 6: Documentazione degli argomenti di funzione Exercise 7: Valori di ritorno delle funzioni ed esportazione Exercise 8: Genera la documentazione dei file di help Exercise 9: Primi passi con le vignette dei pacchetti R Exercise 10: Esplora le vignette del pacchetto Exercise 11: Proprietà di vignette e articoli Exercise 12: Progettare le vignette di un pacchetto R Exercise 13: Genera uno scheletro di vignetta per un pacchetto R

Esercizio attuale

Exercise 14: Progetta una vignetta per un pacchetto R Exercise 15: Crea le vignette del pacchetto

Scopri perché gli unit test sono fondamentali per lo sviluppo e la manutenzione di un pacchetto e impara a usare il pacchetto testthat per i test unitari. Trasforma gli esempi R in expectations per consolidare le tue conoscenze sugli unit test. Capirai poi come documentare i dati del tuo pacchetto ed eseguire alcune verifiche finali per assicurarti di aver sviluppato un pacchetto R solido.

Exercise 1: Test unitari Exercise 2: Vantaggi del unit testing Exercise 3: Prepara il tuo pacchetto per il testing Exercise 4: Crea un file di test Exercise 5: Esplorare le istruzioni expect Exercise 6: Converti un esempio in un test Exercise 7: Controlla avvisi ed errori Exercise 8: Controllare l'output e l'identicità Exercise 9: Salvare le aspettative come unit test ed eseguire i test Exercise 10: Correggi gli errori nelle expectation Exercise 11: Esegui un test sugli esempi della funzione Exercise 12: Esegui tutti i test nel pacchetto Exercise 13: Passi finali Exercise 14: Finalizza il tuo file DESCRIPTION Exercise 15: Documenta i tuoi dati Exercise 16: Verifica il tuo pacchetto R Exercise 17: Congratulazioni!