README.Rmd

---
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%"
)
```


# KetnipzR <img src="hexketnipz.png" width="240px" align="right" /> 

<!-- badges: start -->
![R-CMD-check](https://github.com/lucassxs/KetnipzR/actions/workflows/check-release.yaml/badge.svg)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

<!-- badges: end -->

The goal of KetnipzR is to ...

## Installation

You can install the development version of KetnipzR from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("lucassxs/KetnipzR")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r ketnipzR}
#library(KetnipzR)
# ketnipz_r()
```


In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.