GenderGuesser

commit e1989921ecaa8ec02777a3b30601eb7f74bef75c
parent 5dfaa6bee6e01de4b281473467e0d052d58883b9
Author: Eamon Caddigan <eamon.caddigan@gmail.com>
Date:   Mon, 10 Aug 2015 15:08:02 -0400

Updated with simple instructions.
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
+
+```
+> 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
+```
+
+I have an uncommon name. :)