Volgorde van onderdelen in een helpbestand

Je collega begint net met het documenteren van een eigen functie in een pakket. Help hen om de onderdelen van het helpbestand in de juiste volgorde te zetten, zodat ze weten waar ze verschillende documentatiedelen kunnen vinden.

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

Interactieve oefening met praktijkervaring

Zet theorie om in actie met een van onze interactieve oefeningen

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

SkillTag.level.intermediateSkillTag.label

4.8+

Begin gratis met de cursus

Verdiep je in de basis van het opzetten van een R-pakket, van de architectuur en de cruciale mappen R en man tot het belang van de bestanden DESCRIPTION en NAMESPACE. Ga praktisch aan de slag met het pakket usethis terwijl je een eigen pakketskelet maakt en data toevoegt. Versterk je vaardigheden in het schrijven van R-functies, begrijp best practices voor pakketontwikkeling en raak vertrouwd met het opslaan van functies in een bestand. Installeer tot slot je pakket lokaal met devtools.

Exercise 1: Onderdelen van een R-pakket Exercise 2: Waarheden over R-packages Exercise 3: Wat is nodig in alle R-pakketten?Exercise 4: Vereiste pakketonderdelen Exercise 5: Data en R Markdown-sjabloon in een R-pakket Exercise 6: Maak een R-package Exercise 7: Voeg data toe aan het R-pakket Exercise 8: Maak een R Markdown-sjabloonbestand voor een R-pakket Exercise 9: Indeling van een R Markdown-sjabloonbestand Exercise 10: Pakketfuncties bouwen Exercise 11: R-functie voor het omrekenen van afstanden Exercise 12: Installeer het R-pakket en probeer het uit

Leer de voordelen van pakketten bouwen ten opzichte van scripts gebruiken, en ontdek de impact op codeorganisatie, reproduceerbaarheid, samenwerking en delen. Ontdek effectieve strategieën om code en functies binnen de R-map te structureren, en kies een passende naam en licentie voor je pakket. Tot slot leer je hoe je afhankelijkheden van CRAN-pakketten beheert.

Exercise 1: Meer pakketsstructuur Exercise 2: Packages en scripts vergelijken Exercise 3: Je pakketnaam controleren Exercise 4: Een geschikte licentie kiezen voor je package Exercise 5: Pakket bouwen Exercise 6: Een nieuwe functie toevoegen en testen in het pakket Exercise 7: Fouten debuggen met load_all()Exercise 8: Verschillen tussen check()-fouten, waarschuwingen en notities Exercise 9: Pakketafhankelijkheden Exercise 10: Typen R-package-afhankelijkheden Exercise 11: Pakketafhankelijkheden instellen Exercise 12: Stel meer package-afhankelijkheden in

Benut de kracht van voorbeelden in documentatie door functievoorbeelden te maken met roxygen2. Begrijp het belang van voorbeelden bij het verduidelijken van functiegdrag en het identificeren van de kernelementen van een goed gedocumenteerde R-functie. Verken het doel van vignetten in R-pakketdocumentatie en leer best practices voor het maken van aansprekende vignetten en het beoordelen van hun inhoud en kwaliteit via metadata-analyse.

Exercise 1: Helpbestanden bij R-pakketten Exercise 2: Volgorde van onderdelen in een helpbestand

Huidige oefening

Exercise 3: Geëxporteerde en niet-geëxporteerde functies Exercise 4: Documentatie met roxygen2 Exercise 5: Starters voor functiedocumentatie Exercise 6: Documentatie van functieargumenten Exercise 7: Functieresultaat en exporteren Exercise 8: Helpbestanden genereren Exercise 9: Aan de slag met vignetten voor R-pakketten Exercise 10: Blader door packagevignetten Exercise 11: Eigenschappen van vignettes en artikelen Exercise 12: Vignetten voor R-pakketten ontwerpen Exercise 13: Genereer een skelet voor een R-pakketvignet Exercise 14: Ontwerp een R-packagevignet Exercise 15: Package-vignetten bouwen

Ontdek waarom unittests belangrijk zijn voor de ontwikkeling en het onderhoud van pakketten en leer hoe je het pakket testthat implementeert voor unittests. Zet R-voorbeelden om in expectations om je kennis van unittests op te bouwen. Daarna krijg je inzicht in het documenteren van je pakketdata en voer je enkele laatste checks uit om zeker te weten dat je een robuust R-pakket hebt ontwikkeld.

Exercise 1: Unittests Exercise 2: Voordelen van unit testing Exercise 3: Bereid je package voor op testen Exercise 4: Maak een testbestand Exercise 5: Expect-uitspraken verkennen Exercise 6: Zet een voorbeeld om in een test Exercise 7: Controleer op waarschuwingen en fouten Exercise 8: Controleer op output en identiciteit Exercise 9: Verwachtingen opslaan als unittests en tests uitvoeren Exercise 10: Los expectation-fouten op Exercise 11: Voer een test uit op functievoorbeelden Exercise 12: Voer alle tests in het pakket uit Exercise 13: Laatste stappen Exercise 14: Rond je DESCRIPTION-bestand af Exercise 15: Documenteer je data Exercise 16: Controleer je R-pakket Exercise 17: Gefeliciteerd!