README

Mini-Lecture 20

Ben Baumer

Smith College

2024-11-21

README

README.Rmd

• usethis::use_readme_rmd()

README.md

• Don’t edit by hand!

README content

• use_lifecycle_badge()
• use_logo()
• Format
  • Installation
  • Simple (cool) example 1
  • Simple (cool) example 2
  • See also

Make a hex sticker!

• hexSticker package
• Previous packages had hex stickers!
• Example from macleish

Vignettes

• Longer form documentation
• use_vignette()
• Much more open-ended
• Questions:
  • What can your package do?
  • What should users know about it?
  • How does it work?
  • Show us something cool!

Now

Homework

• Review R package guidelines