-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
147 lines (89 loc) · 3.51 KB
/
README.Rmd
File metadata and controls
147 lines (89 loc) · 3.51 KB
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
---
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%"
)
codecov <- covr::package_coverage() |>
covr::percent_coverage() |>
round(0)
if (codecov <= 75) {
badge_color <- "e05d44"
}
if (codecov > 75) {
badge_color <- "dfb317"
}
if (codecov > 90) {
badge_color <- "a3c51c"
}
if (codecov > 95) {
badge_color <- "44cc11"
}
```
codebergr <img src="man/figures/package-sticker.png" align="right" style="float:right; height:120px;" height="120"/>
=========================================================
<!-- badges: start -->
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
:construction: This is an **EXPERIMENTAL** project! :construction:
<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 `codebergr` is a client to query (GET, POST, DELETE, PUT methods) the Codeberg API. Currently, only the REPOS endpoint is implemented.
## Features
The main purpose of `codebergr` is to... **{{ DESCRIBE THE MAIN FEATURES }}**
## Installation
You can install the development version from [Codeberg](https://codeberg.org/) with:
```{r eval=FALSE}
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install < codebergr > from Codeberg ----
remotes::install_git("https://codeberg.org/frbcesab/codebergr.git")
```
Then you can attach the package `codebergr`:
```{r eval=FALSE}
library("codebergr")
```
## Get started
For an overview of the main features of `codebergr`, please read the
[Get started](https://frbcesab.codeberg.page/codebergr/articles/codebergr.html)
vignette.
## Long-form documentations
`codebergr` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more about the package:
- the [Get started](https://frbcesab.codeberg.page/codebergr/articles/codebergr.html)
vignette describes the core features of the package
- **{{ LIST ADDITIONAL VIGNETTES }}**
## Citation
Please cite `codebergr` as:
> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) codebergr: An R
package to **{{ TITLE }}**. R package version 0.0.0.9000.
<https://codeberg.org/frbcesab/codebergr/>
## Contributing
All types of contributions are encouraged and valued. For more
information, check out our [Contributor
Guidelines](https://codeberg.org/frbcesab/codebergr/src/branch/main/CONTRIBUTING.md).
Please note that the `codebergr` 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 }}**