Rond je DESCRIPTION-bestand af

Het DESCRIPTION-bestand is een cruciaal onderdeel van een R-package, omdat het essentiële metadata en informatie over het package bevat. Het fungeert als centraal punt voor het beschrijven van de titel, versie, auteurs, afhankelijkheden en andere belangrijke details. Het DESCRIPTION-bestand wordt gebruikt voor installatie, distributie en documentatie van het package en zorgt voor een juiste identificatie en werking binnen het R-ecosysteem.

Het bevat allerlei nuttige velden om informatie over het package te documenteren, waaronder de onderdelen Title, Version, Authors@R en Description.

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

Cursus bekijken

Oefeninstructies

Werk het veld Title bij naar Unit Conversion Utilities for Distance, Time, Weight, and Temperature.
Werk het veld Version bij naar 0.1.0.
Werk het veld Authors@R bij naar "R" als de given-naam, "User" als de family-naam, geen middle-naam, en e-mailadres [email protected].
Werk het veld Description bij naar The package provides a collection of utility functions for converting distance, time, weight, and temperature values..

Praktische interactieve oefening

Probeer deze oefening eens door deze voorbeeldcode in te vullen.

{"DESCRIPTION.Rmd":"Package: unitConverter  \nTitle: What the Package Does (One Line, Title Case)  \nVersion: 0.0.0.9000  \nAuthors@R: \n    person(\"First\", \"Last\", , \n           \"[email protected]\", \n           role = c(\"aut\", \"cre\"))\nDescription: What the package does (one paragraph).  \nLicense: CC0  \nEncoding: UTF-8  \nRoxygen: list(markdown = TRUE)  \nRoxygenNote: 7.2.3  \nDepends:  \n    R (>= 2.10)  \nLazyData: true  \nSuggests:   \n    ggplot2 (>= 3.0.0),  \n    tibble,  \n    knitr,  \n    rmarkdown,  \n    testthat (>= 3.0.0)  \nVignetteBuilder: knitr  \nConfig/testthat/edition: 3\n\n\n"}

Code bewerken en uitvoeren

Deze oefening maakt deel uit van de cursus

R-pakketten ontwikkelen

SkillTag.level.intermediateSkillTag.label

4.8+

Begin de cursus gratis

Dive into the essentials of R package construction, from understanding the architecture, the critical R and man directories, to the significance of the DESCRIPTION and NAMESPACE files. Get hands-on with the usethis package as you create your own package skeleton and include data. Strengthen your R function writing skills, grasp best practices for package development, and get comfortable saving functions to a file. Finally, install your package locally using devtools.

Exercise 1: Components of an R package Exercise 2: R package truths Exercise 3: What's needed in all R packages?Exercise 4: Required package components Exercise 5: Data and R Markdown template in an R package Exercise 6: Create an R package Exercise 7: Add data to the R package Exercise 8: Create an R package R Markdown template file Exercise 9: R Markdown template file layout Exercise 10: Building package functions Exercise 11: R function for converting distances Exercise 12: Install the R package and try it out

Learn the advantages of creating packages versus using scripts, exploring the impact on code organization, reproducibility, collaboration, and sharing. Discover effective strategies for structuring code and functions within the R directory, and choosing an appropriate name and license for your package. Finally, you’ll learn how to manage CRAN package dependencies.

Exercise 1: More package structure Exercise 2: Comparing packages and scripts Exercise 3: Checking your package name Exercise 4: Choosing an appropriate license for your package Exercise 5: Package build Exercise 6: Adding and testing a new function in the package Exercise 7: Debug errors with load_all()Exercise 8: Differences between check() errors, warnings, and notes Exercise 9: Package dependencies Exercise 10: Types of R package dependencies Exercise 11: Set package dependencies Exercise 12: Set more package dependencies

Harness the power of examples in documentation by creating function examples with roxygen2. Understand the significance of examples in clarifying function behavior and identifying key components of a well-documented R function. Explore the purpose of vignettes in R package documentation and learn best practices for creating engaging vignettes and evaluating their content and quality through metadata analysis.

Exercise 1: Help files with R packages Exercise 2: Order of help file components Exercise 3: Exported and non-exported functions Exercise 4: Documentation with roxygen2 Exercise 5: Function documentation starters Exercise 6: Function argument documentation Exercise 7: Function returns and exporting Exercise 8: Generate help file documentation Exercise 9: Getting started with R package vignettes Exercise 10: Browse package vignette Exercise 11: Properties of vignettes and articles Exercise 12: Designing R package vignettes Exercise 13: Generate an R package vignette skeleton Exercise 14: Design an R package vignette Exercise 15: Build package vignettes

Identify why the unit tests are important to package development and maintenance and learn how to implement the testthat package for unit tests. Convert R examples into expectations to build your unit test knowledge. You’ll then gain an understanding on how to document your package data and run some final checks to ensure you have developed a robust R package.

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

Huidige oefening

Exercise 15: Documenteer je data Exercise 16: Controleer je R-pakket Exercise 17: Gefeliciteerd!