commit 8c0694aaf55a9e9aee078f10f426e41f623c9c4c
parent 23920ff3fb43614306b103c7fac08f462bf5b80e
Author: Eamon Caddigan <eamon.caddigan@gmail.com>
Date: Tue, 11 Aug 2015 22:16:40 -0400
Explaining API limits
Diffstat:
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
# GenderGuesser
-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.
+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 (and on CRAN), but it was missing enough of the features I wanted that it made more sense to write my own code than fork that project.
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
+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.
+Calling `guessGender` with one or more names returns a `data.frame`.
```r
library("GenderGuesser")
@@ -24,4 +24,8 @@ guessGender(c("Liam", "Natalie", "Eamon"))
#>3 Eamon male NA NA 1.00 63
```
-"Eamon" is an uncommon name, but only boys seem to have it so far.
+"Eamon" is an uncommon name, but only boys seem to have it so far.
+
+## Limits
+
+[genderize.io](https://genderize.io/) limits each IP address to 100 (free) queries per day, and each query can contain up to ten names. `guessGender` does the work of splitting a vector of arbitrary length into ten-name queries and combines the results. However, only one country or language code can be passed to the function, so querying, e.g., a single name in multiple countries must be done using multiple calls to `guessGender`.
