syntreesysTools

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

Overview

The R package syntreesysTools… {{ DESCRIBE YOUR PACKAGE }}

Features

The main purpose of syntreesysTools 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 < syntreesysTools > from GitHub ----
remotes::install_github("SynTreeSys/syntreesysTools")

Then you can attach the package syntreesysTools:

library("syntreesysTools")

Get started

For an overview of the main features of syntreesysTools, please read the Get started vignette.

Long-form documentations

syntreesysTools 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 syntreesysTools as:

Lima Renato (2024) syntreesysTools: An R package to {{ TITLE }}. R package version 0.0.0.9000. https://github.com/SynTreeSys/syntreesysTools/

Contributing

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

Please note that the syntreesysTools 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 }}