-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
127 lines (73 loc) · 3.82 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%")
```
syntreesysTools <img src="man/figures/package-sticker.png" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://CRAN.R-project.org/package=syntreesysTools)
[](https://github.com/SynTreeSys/syntreesysTools/actions/workflows/R-CMD-check.yaml)
[](https://github.com/SynTreeSys/syntreesysTools/actions/workflows/pkgdown.yaml)
[](https://github.com/SynTreeSys/syntreesysTools/actions/workflows/test-coverage.yaml)
[](https://codecov.io/gh/SynTreeSys/syntreesysTools)
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
<p align="left">
• <a href="#overview">Overview</a><br>
• <a href="#features">Features</a><br>
• <a href="#installation">Installation</a><br>
• <a href="#get-started">Get started</a><br>
• <a href="#long-form-documentations">Long-form documentations</a><br>
• <a href="#citation">Citation</a><br>
• <a href="#contributing">Contributing</a><br>
• <a href="#acknowledgments">Acknowledgments</a><br>
• <a href="#references">References</a>
</p>
## 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](https://github.com/) with:
```{r eval=FALSE}
## 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`:
```{r eval=FALSE}
library("syntreesysTools")
```
## Get started
For an overview of the main features of `syntreesysTools`, please read the
[Get started](https://SynTreeSys.github.io/syntreesysTools/articles/syntreesysTools.html)
vignette.
## Long-form documentations
`syntreesysTools` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more about the package:
- the [Get started](https://SynTreeSys.github.io/syntreesysTools/articles/syntreesysTools.html)
vignette describes the core features of the package
- **{{ LIST ADDITIONAL VIGNETTES }}**
## Citation
Please cite `syntreesysTools` as:
> Lima Renato (`r format(Sys.Date(), "%Y")`) 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](https://github.com/SynTreeSys/syntreesysTools/blob/main/CONTRIBUTING.md).
Please note that the `syntreesysTools` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.
## Acknowledgments
**{{ OPTIONAL SECTION }}**
## References
**{{ OPTIONAL SECTION }}**