GenderGuesser

commit 26e1a453d9ddf0575885050a5133c4a241b161a5
parent 28dfad8130d221ca82b40233f16eca929d5976f4
Author: eamoncaddigan <eamon.caddigan@gmail.com>
Date:   Tue, 11 Aug 2015 07:46:15 -0400

Merge branch 'master' of github.com:eamoncaddigan/GenderGuesser

Diffstat:
M
README.md
 | 
22
++++++++++++++++++++++

1 file changed, 22 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -3,3 +3,25 @@
 Here's an R package for using the [genderize.io](https://genderize.io/) API to guess the gender of a name. There's already a really good [genderizeR](https://github.com/kalimu/genderizeR) package out there, but it was missing the features I wanted. 
 
 To use it, call `guessGender` with a character vector of (first) names. You can optionally pass (one of) a language code or country code to fine-tine results. If you've paid for an API key through [genderize.io](https://genderize.io/), you can pass that too.
+
+## Example
+
+Use the devtools package to install GenderGuesser
+
+```r
+library("devtools")
+install_github("eamoncaddigan/GenderGuesser")
+```
+
+Calling `guessGender` with one or more names returns a data.frame.
+
+```r
+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
+```
+
+"Eamon is an uncommon name, but only boys seem to have it. :)