GenderGuesser

commit 21d447d7bc65037993699255a149326806a3bb1c
parent e1989921ecaa8ec02777a3b30601eb7f74bef75c
Author: Eamon Caddigan <eamon.caddigan@gmail.com>
Date:   Mon, 10 Aug 2015 17:12:50 -0400

Using conventions for documenting examples
Diffstat:
M
README.md
 | 
20
++++++++++----------

1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -8,20 +8,20 @@ To use it, call `guessGender` with a character vector of (first) names. You can 
 
 Use the devtools package to install GenderGuesser
 
-```
-> library("devtools")
-> install_github("eamoncaddigan/GenderGuesser")
+```r
+library("devtools")
+install_github("eamoncaddigan/GenderGuesser")
 ```
 
 Calling `guessGender` with one or more names returns a data.frame.
 
 ```
-> library("GenderGuesser")
-> guessGender(c("Liam", "Natalie", "Eamon"))
-     name gender country_id language_id probability count
-1    Liam   male         NA          NA        0.99   623
-2 Natalie female         NA          NA        1.00  2033
-3   Eamon   male         NA          NA        1.00    63
+library("GenderGuesser")
+guessGender(c("Liam", "Natalie", "Eamon"))
+#>     name gender country_id language_id probability count
+#>1    Liam   male         NA          NA        0.99   623
+#>2 Natalie female         NA          NA        1.00  2033
+#>3   Eamon   male         NA          NA        1.00    63
 ```
 
-I have an uncommon name. :)
+"Eamon is an uncommon name, but only boys seem to have it. :)