In rcompendium: Create a Package or Research Compendium Structure

knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "man/figures/",
                      out.width = "100%")

{{project_name}}

• Overview
• Features
• Installation
• Get started
• Long-form documentations
• Citation
• Contributing
• Acknowledgments
• References

Overview

The R package {{project_name}}... {{ DESCRIBE YOUR PACKAGE }}

Features

The main purpose of {{project_name}} is to... {{ DESCRIBE THE MAIN FEATURES }}

Installation

You can install the development version from GitHub with:

## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

## Install < {{project_name}} > from GitHub ----
remotes::install_github("{{github}}/{{project_name}}")

Then you can attach the package {{project_name}}:

library("{{project_name}}")

Get started

For an overview of the main features of {{project_name}}, please read the Get started vignette.

Long-form documentations

{{project_name}} provides {{ NUMBER OF VIGNETTES }} vignettes to learn more about the package:

• the Get started vignette describes the core features of the package
• {{ LIST ADDITIONAL VIGNETTES }}

Citation

Please cite {{project_name}} as:

{{family}} {{given}} (r format(Sys.Date(), "%Y")) {{project_name}}: An R package to {{ TITLE }}. R package version {{pkg_version}}. https://github.com/{{github}}/{{project_name}}/

Contributing

All types of contributions are encouraged and valued. For more information, check out our Contributor Guidelines.

Please note that the {{project_name}} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Acknowledgments

{{ OPTIONAL SECTION }}

References

{{ OPTIONAL SECTION }}

rcompendium documentation built on Oct. 26, 2023, 5:08 p.m.