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

# josaplay [<img src="man/figures/logo.png" align="right" height=140/>](https://mrchypark.github.io/josaplay/index.html)
 
<!-- 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/mrchypark/josaplay/workflows/R-CMD-check/badge.svg)](https://github.com/mrchypark/josaplay/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/josaplay)](https://CRAN.R-project.org/package=josaplay)
[![runiverse-name](https://mrchypark.r-universe.dev/badges/:name)](https://mrchypark.r-universe.dev/)
[![runiverse-package](https://mrchypark.r-universe.dev/badges/josaplay)](https://mrchypark.r-universe.dev/ui#packages)
[![metacran downloads](https://cranlogs.r-pkg.org/badges/josaplay)](https://cran.r-project.org/package=josaplay)
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/josaplay)](https://cran.rstudio.com/package=josaplay)
[![Codecov test coverage](https://codecov.io/gh/mrchypark/josaplay/branch/main/graph/badge.svg)](https://app.codecov.io/gh/mrchypark/josaplay?branch=main)
<!-- badges: end -->

The goal of josaplay is to provide functions to add josa in Korean text. It is useful with Rmarkdown.

## Installation

```r
# CRAN version
install.packages("josaplay")

# Dev version
install.packages('josaplay', repos = c('https://mrchypark.r-universe.dev', 'https://cloud.r-project.org'))
```

## Example

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

### v0.2.0

Breaking change from v0.1.3

```{r}
library(josaplay)
# 과/와
josa("상품", "과")
josa("상품", "와")
josa("텀블러", "과")
josa("텀블러", "와")

# number
josa("145", "이")
josa("k146", "이")
```

### support josa

을 / 를    
은 / 는    
이 / 가    
과 / 와    
이나 / 나    
으로 / 로    
아 / 야    
이랑 / 랑    
이며 / 며    
이다 / 다    
이가 / 가    
 
* All josa can use `select` param on `josa(textko, select)` but `가` is work as only `이/가` not `이가/가`.


## Todo

- support only jamo character
- support English letters
- support special character