-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
44 lines (31 loc) · 1.37 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
---
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/README-",
out.width = "100%"
)
```
# {clemantine} <img src="man/figures/logo.png" align="right" height="138" alt="" />
<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/ThinkR-open/clemantine/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/clemantine/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
`{clemantine}` is a package that provides a set of functions around the React component library [Mantine](https://mantine.dev/).
## Installation
You can install the development version of `{clemantine}` from [GitHub](https://github.com/) with:
```{r, eval=FALSE}
# install.packages("devtools")
devtools::install_github("ThinkR-open/clemantine")
```
## How to use clemantine?
```{r example, eval=FALSE}
library(clemantine)
```
_TODO_
## Code of Conduct
Please note that the clemantine 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.