imperialCHEPI / healthgpsrvis

A set of scripts for plotting and visualising data related to Health-GPS
https://imperialchepi.github.io/healthgpsrvis/
Other
0 stars 0 forks source link

Convert roxygen2 comments to markdown #57

Closed SaranjeetKaur closed 2 months ago

SaranjeetKaur commented 2 months ago

Turn on Markdown support for the healthgpsrvis package :

  1. Since we’re updating an existing package, running usethis::use_roxygen_md() will modify the DESCRIPTION (to include Roxygen: [list](https://rdrr.io/r/base/list.html)(markdown = TRUE)) and prompt us to use the roxygen2md package to convert the existing docs.
  2. Once the package roxygen2md is downloaded, run roxygen2md::roxygen2md() to convert existing Rd comments to markdown.
  3. Run devtools::document() when you're done.
  4. Finally run devtools::check().