adamvi / packageskeletonforr

A package skeleton for starting an R package

packageSkeletonForR

Overview

The packageSkeletonForR GitHub repository (repo, for short) contains an R package skeleton suitable for setting up a GitHub based R package with an associated GitHub static website. GitHub is an ideal environment for developing, maintaining, and distributing an R package. And it's SUPER cool too! 😀

The bulk of the work in using this package skeleton will be in customizing the package (e.g., changing the name of the package to something you want to call it). Many people don't create R packages because they don't think they have anything worthy to put into a package. Instead of thinking about making a package that is useful for someone else, think of making a package that is useful for yourself and what you do. You will often find that solutions to your own data issues are often utilized by others.

There some minor prerequisite knowlege for doing this (which can be figured out as part of setting this up) includes:

• Knowing the basics of GitHub including cloning a repo, making a commit to a repo, pushing changes to a repo.
• Knowing the basics of R and what an R package is.
• Considering some things to add to your R package. For example, your R package could contain:
  • Useful little data cleaning functions that may apply to data that you normally work with.
  • Useful wrapper functions that use functions from base R, your own work and/or other packages that provide output in a way that you best work with.
  • Data sets that you commonly reference.
  • And don't be afraid to steal (with attribution, of course) stuff from other packages and put them into your package (with possible customizations). This is open source, you know!

This vignette takes you through the steps necessary to use this package skeleton to set up your own repo/R package.