Skip to content

Commit

Permalink
simplify index
Browse files Browse the repository at this point in the history
  • Loading branch information
scumdogsteev committed Aug 13, 2017
1 parent 3a97bae commit 6deaaa2
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 60 deletions.
24 changes: 0 additions & 24 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 1 addition & 36 deletions index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -49,39 +49,4 @@ 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)
```

**`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:"

```{r letterToNumber}
string <- "Texas"
letterToNumber(string)
```

**`numberToLetter`** converts a string containing numbers into the corresponding
letters on a telephone's keypad. For example, if the user wants to know what
possible character strings could be spelled by a sequence of numbers (e.g., 22):

```{r numberToLetter ex1}
string <- "22"
numberToLetter(string)
```
```

0 comments on commit 6deaaa2

Please sign in to comment.