https://github.com/k3jph/phonics-in-rust

Phonetic Spelling Algorithms in Rust
https://github.com/k3jph/phonics-in-rust

linguistics mit-license phonetic-spelling-algorithms phonics record-linkage rust rust-lang text-processing

Last synced: 7 months ago
JSON representation

Phonetic Spelling Algorithms in Rust

• Host: GitHub
• URL: https://github.com/k3jph/phonics-in-rust
• Owner: k3jph
• License: mit
• Created: 2020-06-07T14:57:05.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2020-07-06T01:49:08.000Z (over 5 years ago)
• Last Synced: 2025-01-16T11:42:03.611Z (9 months ago)
• Topics: linguistics, mit-license, phonetic-spelling-algorithms, phonics, record-linkage, rust, rust-lang, text-processing
• Language: Rust
• Homepage:
• Size: 50.8 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Phonetic Spelling Algorithms in Rust

[![Download](https://img.shields.io/crates/d/phonics)](https://crates.io/crates/phonics)

[![License](https://img.shields.io/crates/l/phonics)](https://github.com/Hoverbear/getset/blob/master/LICENSE)

[![Docs](https://docs.rs/phonics/badge.svg)](https://docs.rs/phonics/)

[![Build Status](https://img.shields.io/travis/k3jph/phonics-in-rust.svg)](https://travis-ci.org/k3jph/phonics-in-rust)

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

This is a package to port the [Phonics in

R](https://howardjp.github.io/phonics/) package to Rust.  In large

part, this package is being developed to learn how to program in

Rust.  Accordingly, there is a substantial effort to translate the

phonetic tools into _idiomatic_ Rust.  Each algorithm is implemented

as a separate struct based on a `PhoneticEncoder` trait, providing

a uniform interface.  This package is not a high priority for the

author and will likely be developed slowly.

## Algorithms included

* Lein

_More to come, as they are reimplemented from the R package._

## Dependencies

* [regex](https://crates.io/crates/regex)

## Contribution guidelines

* Use [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/)

* Write unit tests

* Document your functions

## For more information

* [Phonics in R website](https://howardjp.github.io/phonics/)

* James P. Howard, II <>

## Acknowledgements

This work used the [Extreme Science and Engineering Discovery

Environment](https://www.xsede.org/) (XSEDE), which is supported

by National Science Foundation grant number ACI-1548562. In particular,

it used the Comet system at the [San Diego Supercomputing

Center](https://www.sdsc.edu/) (SDSC) through allocations TG-DBS170012

and TG-ASC150024.