-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Scumdogsteev
committed
Aug 16, 2015
1 parent
80a2188
commit 0ad0fdc
Showing
2 changed files
with
61 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,11 @@ knitr::opts_chunk$set( | |
| ) | ||
| ``` | ||
|
|
||
| [](https://travis-ci.org/scumdogsteev/phonenumber) [](https://coveralls.io/github/scumdogsteev/phonenumber?branch=master) | ||
| [](http://cran.r-project.org/package=mlsjunkgen) [](https://travis-ci.org/scumdogsteev/phonenumber) [](https://coveralls.io/github/scumdogsteev/phonenumber?branch=master) | ||
|
|
||
| # phonenumber | ||
|
|
||
| **`phonenumber`** is an R package that convert English letters to numbers or | ||
| **`phonenumber`** is an R package that converts English letters to numbers or | ||
| numbers to English letters as on a telephone keypad. | ||
|
|
||
| Author: Steve Myles ([email protected]) | ||
|
|
@@ -27,7 +27,7 @@ Project Home: http://steve.mylesandmyles.info/projects/phonenumber/ | |
|
|
||
| License: MIT license | ||
|
|
||
| #### Background | ||
| ### Background | ||
|
|
||
| When I recently posted some of my [Turbo Pascal Stuff](http://steve.mylesandmyles.info/projects/turbo-pascal-stuff/), I found an incomplete | ||
| program that was supposed to do this. I was active on [BBSes](https://en.wikipedia.org/wiki/Bulletin_board_system) and, though I don't | ||
|
|
@@ -43,34 +43,6 @@ I decided to create this functionality in R for three reasons: | |
| 3. to serve as a possible pedagogical example for others as it involves working | ||
| with lists, splitting strings, and the [expand.grid](https://stat.ethz.ch/R-manual/R-devel/library/base/html/expand.grid.html) function. | ||
|
|
||
| ### Installation | ||
|
|
||
| * `phonenumber` is available [on CRAN](http://cran.r-project.org/web/packages/phonenumber/index.html) and can be | ||
| installed accordingly: | ||
| ```r | ||
| install.packages("phonenumber") | ||
| library(phonenumber) | ||
| ``` | ||
| * You can also install `phonenumber` from GitHub using the `devtools` package: | ||
| ```r | ||
| install.packages("devtools") | ||
| library("devtools") | ||
| install_github("scumdogsteev/phonenumber") | ||
| library(phonenumber) | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| The package consists of two | ||
| functions: | ||
|
|
||
| 1. `letterToNumber` - converts letters in a string to numbers | ||
| 2. `numberToLetter` - converts numbers in a string to letters | ||
|
|
||
| Both functions convert non-alphanumeric characters to dash (-) and perform no | ||
| conversion on their respective base character type (i.e., `letterToNumber` | ||
| leaves letters as is and `numberToLetter` leaves numbers as is). | ||
|
|
||
| #### Telephone keypad | ||
|
|
||
| For purposes of this package, the mapping of numbers to letters on a telephone's | ||
|
|
@@ -98,7 +70,34 @@ keypad are as follows: | |
| * 0 corresponds to Q, Z | ||
| * 1 has no corresponding letters | ||
|
|
||
| #### Examples | ||
| ### Installation | ||
|
|
||
| * `phonenumber` is available [on CRAN](http://cran.r-project.org/web/packages/phonenumber/index.html) and can be | ||
| installed accordingly: | ||
| ```r | ||
| install.packages("phonenumber") | ||
| library(phonenumber) | ||
| ``` | ||
| * You can also install `phonenumber` from GitHub using the `devtools` package: | ||
| ```r | ||
| install.packages("devtools") | ||
| library("devtools") | ||
| install_github("scumdogsteev/phonenumber") | ||
| library(phonenumber) | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| The package consists of two functions: | ||
|
|
||
| 1. `letterToNumber` - converts letters in a string to numbers | ||
| 2. `numberToLetter` - converts numbers in a string to letters | ||
|
|
||
| Both functions convert non-alphanumeric characters to dash (-) and perform no | ||
| conversion on their respective base character type (i.e., `letterToNumber` | ||
| leaves letters as is and `numberToLetter` leaves numbers as is). | ||
|
|
||
| ### Examples | ||
|
|
||
| ```{r library, echo=FALSE} | ||
| library(phonenumber) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,18 @@ | ||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
| [](https://travis-ci.org/scumdogsteev/phonenumber) [](https://coveralls.io/github/scumdogsteev/phonenumber?branch=master) | ||
| [](http://cran.r-project.org/package=mlsjunkgen) [](https://travis-ci.org/scumdogsteev/phonenumber) [](https://coveralls.io/github/scumdogsteev/phonenumber?branch=master) | ||
|
|
||
| phonenumber | ||
| =========== | ||
|
|
||
| **`phonenumber`** is an R package that convert English letters to numbers or numbers to English letters as on a telephone keypad. | ||
| **`phonenumber`** is an R package that converts English letters to numbers or numbers to English letters as on a telephone keypad. | ||
|
|
||
| Author: Steve Myles (<[email protected]>) | ||
|
|
||
| Project Home: <http://steve.mylesandmyles.info/projects/phonenumber/> | ||
|
|
||
| License: MIT license | ||
|
|
||
| #### Background | ||
| ### Background | ||
|
|
||
| When I recently posted some of my [Turbo Pascal Stuff](http://steve.mylesandmyles.info/projects/turbo-pascal-stuff/), I found an incomplete program that was supposed to do this. I was active on [BBSes](https://en.wikipedia.org/wiki/Bulletin_board_system) and, though I don't recall the reason, I wanted a way to determine the possible words spelled by the BBS phone numbers (and/or how to determine what phone numbers correspond to words/phrases). I never got around to finishing the second part (numbers to letters) in Turbo Pascal, though. | ||
|
|
||
|
|
@@ -22,6 +22,32 @@ I decided to create this functionality in R for three reasons: | |
| 2. to learn to publish a package to CRAN | ||
| 3. to serve as a possible pedagogical example for others as it involves working with lists, splitting strings, and the [expand.grid](https://stat.ethz.ch/R-manual/R-devel/library/base/html/expand.grid.html) function. | ||
|
|
||
| #### Telephone keypad | ||
|
|
||
| For purposes of this package, the mapping of numbers to letters on a telephone's keypad are as follows: | ||
|
|
||
| - *Default behavior* - if parameter `qz` is omitted (or has a value other than 0): | ||
| - 2 corresponds to A, B, C | ||
| - 3 corresponds to D, E, F | ||
| - 4 corresponds to G, H, I | ||
| - 5 corresponds to J, K, L | ||
| - 6 corresponds to M, N, O | ||
| - 7 corresponds to P, Q, R, S | ||
| - 8 corresponds to T, U, V | ||
| - 9 corresponds to W, X, Y, Z | ||
| - 0 and 1 have no corresponding letters | ||
| - *Alternate behavior* - if parameter `qz` = 0: | ||
| - 2 corresponds to A, B, C | ||
| - 3 corresponds to D, E, F | ||
| - 4 corresponds to G, H, I | ||
| - 5 corresponds to J, K, L | ||
| - 6 corresponds to M, N, O | ||
| - 7 corresponds to P, R, S | ||
| - 8 corresponds to T, U, V | ||
| - 9 corresponds to W, X, Y | ||
| - 0 corresponds to Q, Z | ||
| - 1 has no corresponding letters | ||
|
|
||
| ### Installation | ||
|
|
||
| - `phonenumber` is available [on CRAN](http://cran.r-project.org/web/packages/phonenumber/index.html) and can be installed accordingly: | ||
|
|
@@ -49,33 +75,7 @@ The package consists of two functions: | |
|
|
||
| Both functions convert non-alphanumeric characters to dash (-) and perform no conversion on their respective base character type (i.e., `letterToNumber` leaves letters as is and `numberToLetter` leaves numbers as is). | ||
|
|
||
| #### Telephone keypad | ||
|
|
||
| For purposes of this package, the mapping of numbers to letters on a telephone's keypad are as follows: | ||
| - *Default behavior* - if parameter `qz` is omitted (or has a value other than 0): | ||
| - 2 corresponds to A, B, C | ||
| - 3 corresponds to D, E, F | ||
| - 4 corresponds to G, H, I | ||
| - 5 corresponds to J, K, L | ||
| - 6 corresponds to M, N, O | ||
| - 7 corresponds to P, Q, R, S | ||
| - 8 corresponds to T, U, V | ||
| - 9 corresponds to W, X, Y, Z | ||
| - 0 and 1 have no corresponding letters | ||
| - *Alternate behavior* - if parameter `qz` = 0: | ||
| - 2 corresponds to A, B, C | ||
| - 3 corresponds to D, E, F | ||
| - 4 corresponds to G, H, I | ||
| - 5 corresponds to J, K, L | ||
| - 6 corresponds to M, N, O | ||
| - 7 corresponds to P, R, S | ||
| - 8 corresponds to T, U, V | ||
| - 9 corresponds to W, X, Y | ||
| - 0 corresponds to Q, Z | ||
| - 1 has no corresponding letters | ||
| #### Examples | ||
| ### Examples | ||
|
|
||
| **`letterToNumber`** converts a string containing letters into the corresponding numbers on a telephone's keypad. For example, if the user wants to know what telephone number corresponds to "Texas:" | ||
|
|
||