Package overview

nat.devtools-package

nat.devtools: Tools to help develop natverse packages

Package setup

use_nat_description_defaults()

Set default authorship/package DESCRIPTION information in your Rprofile

Top level function

Use this for initial setup of a package.

nat_setup_package()

Setup a package in natverse style

Transferring a package

Use this to help transfer a package to the natverse GitHub organisation.

nat_check_urls()

Check for files containing old jefferis/lab URLs.

Mid level functions

Use these to setup the README or pkgdown help for an existing package.

nat_setup_badges()

Adds all standard badges to your README.md

nat_setup_pkgdown()

Setup pkgdown according to natverse conventions

Low level functions

add_badge_comments()

Add special marker comments delimiting the badge section of package README

use_doc_badge() use_cran_downloads_badge() use_natverse_badge()

Add natverse badges to package README

use_nat_support()

Add a SUPPORT.md file with information about getting help

Website helpers

Functions to automate work on the natverse website

nat_hugo_addarticle()

Create an article from a rmarkdown file and add it in a hugo repository