Forwards Package development module: Package documentation

R Forwards

A  module in the "R Forwards Package Development for women and other underrepresented groups" curriculum

<h1>Package documentation</h1><p>This workshop shows you how to document your package. </p><h2>Learning Objectives</h2><p>At the end of this module the successful learner will be able to:</p><ul><li>recognise the different levels of package documentation: Metadata, Object documentation, Vignettes and pkgdown sites</li><li>explain, create and populate a DESCRIPTION file  </li><li>know how to add package dependencies with usethis::use_package() and the difference between Imports and Suggests</li><li>explain the components of a LICENSE file</li><li>add object documentation using roxygen2 and devtools::document()</li><li>explain what a vignette is and create one with usethis::use_vignette()</li><li>know how pkgdown sites can be created</li></ul><h2>Prerequisites</h2><p>You need to have:</p><ul><li>&quot;<a href="https://www.eventbrite.co.uk/myevent?eid=164007818801" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">Packages in a nutshell</a>&quot; or equivalent experience</li><li>&quot;<a href="https://www.eventbrite.co.uk/e/164007602153" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">Setting up your system</a>&quot; or equivalent experience</li><li>&quot;<a href="https://www.eventbrite.co.uk/e/164007969251" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">Your first package</a>&quot; or equivalent experience</li><li>the packages devtools, roxygen2, testthat and knitr installed</li><li>R build toolchain: Rtools(windows) or XCode (mac) or r-base-dev</li></ul><h2>Joining Instructions</h2><p>These will be emailed to participants about 24 hours before the workshop. </p><h1>About R Forwards</h1><p>R Forwards is an R Foundation task force that was originally set up in December 2015 to address the underrepresentation of women in the R community.  An analysis of CRAN package maintainers estimated that fewer than 15% were women, and a useR! participant survey found that women were less likely than men to have experience contributing to or writing packages. In 2017 it was rebranded to accommodate other under-represented groups such as LGBTQI, minority ethnic groups, and people with disabilities. </p><p>Forwards have delivered face-to-face one-day workshops in Package development, supported by a grant from the R Consortium,  for several years. These are heavily based on the <a href="https://r-pkgs.org/" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">R packages</a> book by Hadley Wickham and Jenny Bryan. Recently we have been modularising our workshop materials to increase our reach by developing and delivering approximately one hour workshops suitable for online delivery and easy reuse by others.</p><p><a href="https://github.com/forwards/workshops/tree/master/package-dev-modules" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">Module design guiding principles</a> </p>

Our {communityGuidelinesLink} describe the sort of content we prohibit on Eventbrite. If you suspect an event may be in violation, you can report it to us so we can investigate.

To report other categories of prohibited or illegal content, submit {link}

Forwards Package development module: Package documentation

More events from R Forwards

Discover more events from R Forwards, from Science & Tech to other experiences you might love.

Still looking for the right event?

Explore all online events to browse and filter by date, category, and more.

Forwards Package development module: Package documentation

More events from R Forwards

Discover more events from R Forwards, from Science & Tech to other experiences you might love.

More Science & Tech events

Browse more Science & Tech events with different dates, prices, and formats to find your next great experience.

Still looking for the right event?

Explore all online events to browse and filter by date, category, and more.