https://github.com/tallguyjenks/runes

🧙‍♀️ ᚱᚢᚾᛖᛋ in your R Documents!
https://github.com/tallguyjenks/runes

bryan-jenks cran elder-futhark-runes futhark futhark-runes linguistics nordic r rstats rstudio rune runes

Last synced: 5 months ago
JSON representation

🧙‍♀️ ᚱᚢᚾᛖᛋ in your R Documents!

• Host: GitHub
• URL: https://github.com/tallguyjenks/runes
• Owner: tallguyjenks
• License: other
• Created: 2020-01-24T06:19:50.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-13T06:44:12.000Z (over 4 years ago)
• Last Synced: 2024-05-21T12:15:12.354Z (11 months ago)
• Topics: bryan-jenks, cran, elder-futhark-runes, futhark, futhark-runes, linguistics, nordic, r, rstats, rstudio, rune, runes
• Language: R
• Homepage:
• Size: 36 MB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - tallguyjenks/runes - 🧙‍♀️ ᚱᚢᚾᛖᛋ in your R Documents! (R)

README

        


runes - ᚱᚢᚾᛖᛋ 



> Have you ever wanted Runes in your R Documents? Of course you did! so here's a package that gives you that functionality.

[![R build status](https://github.com/tallguyjenks/runes/workflows/R-CMD-check/badge.svg)](https://github.com/tallguyjenks/runes/actions)

[![CRAN checks](https://cranchecks.info/badges/summary/runes)](https://cran.r-project.org/web/checks/check_results_runes.html)

[![](https://www.r-pkg.org/badges/version/runes?color=orange)](https://cran.r-project.org/package=runes)

[![](http://cranlogs.r-pkg.org/badges/grand-total/runes?color=blue)](https://cran.r-project.org/package=runes)

[![](http://cranlogs.r-pkg.org/badges/last-month/runes?color=blue)](https://cran.r-project.org/package=runes)

[![](http://cranlogs.r-pkg.org/badges/last-week/runes?color=blue)](https://cran.r-project.org/package=runes)

[![](https://img.shields.io/badge/RDocumentation-0.1.0-blue)](https://www.rdocumentation.org/packages/runes/versions/0.1.0)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3868253.svg)](https://doi.org/10.5281/zenodo.3868253)

[![](https://img.shields.io/badge/ORCiD-0000--0002--9604--3069-green)](https://orcid.org/0000-0002-9604-3069)

runes is a package to convert English _A-Z_ characters to Runes. There is a LaTeX package to do this with RMarkdown, but why not make it easier and more intuitive to get the runes you need when you need them? `runes("any string or vector here")` works as you'd expect.

I did not find a package in R that does this so i made it myself, so if you work with old Germanic runes for linguistic purposes or just really like runes like me, hopefully this will be a package you will get some use out of.

## What Does It Look Like?

![](./img/runesPreview.png)

## Dependencies

- None: Relies only on **base** functions.

## Installation

```r

# CRAN version:

install.packages("runes")

# OR for the development version:

remotes::install_github("tallguyjenks/runes")

```

## Usage

```r

library(runes)

runes("hello world!")

#> [1] "ᚻᛖᛚᛚᛟ ᚹᛟᚱᛚᛞ!"

```

If you want a complete translation table of unicode sequence --> English Transcription --> Rune Character you can call the `runes_table()` function that returns a data.frame of these items so you can use this for reference or input them into a document using the `DT`, `kable`, etc packages.

- `runes` can work with the pipe `%>%` to take a single string output as a piped input

- You can feed `runes` a string to format the output for any other function such as a console `cli::cli_h1(runes("This is a level 1 heading in runes"))`

- Let me know some of the uses YOU have made with it!

## How to Contribute

1. Read CONTRIBUTING

2. Clone repository and create a new branch.

3. Make changes and test

4. Submit Pull Request with comprehensive description of changes

## Acknowledgements

## Donations

This is free, open-source software. If you'd like to support the development of future projects, or say thanks for this one, you can donate to me through [paypal](https://www.paypal.me/tallguyjenks)



## License

MIT