| Type: | Package |
| Language: | en-US |
| Title: | Client for 'GenderAPI.io' |
| Version: | 1.0.3 |
| Description: | Provides an interface to the 'GenderAPI.io' web service (https://www.genderapi.io) for determining gender from personal names, email addresses, or social media usernames. Functions are available to submit single or batch queries and retrieve additional information such as accuracy scores and country-specific gender predictions. This package simplifies integration of 'GenderAPI.io' into R workflows for data cleaning, user profiling, and analytics tasks. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/GenderAPI/genderapi-R |
| BugReports: | https://github.com/GenderAPI/genderapi-R/issues |
| Imports: | httr, jsonlite |
| Depends: | R (≥ 3.5.0) |
| Encoding: | UTF-8 |
| Suggests: | testthat |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2025-07-09 12:03:21 UTC; onurozturk |
| Author: | Onur Ozturk [aut, cre] |
| Maintainer: | Onur Ozturk <onurozturk1980@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-07-14 17:00:10 UTC |
Get Gender by Email
Description
Get Gender by Email
Usage
get_gender_by_email(api_key, email, country = NULL, askToAI = FALSE)
Arguments
api_key |
Your GenderAPI.io API key. |
email |
Email string to check. |
country |
Optional two-letter country code (e.g. "US"). |
askToAI |
Logical. TRUE to force AI lookup, FALSE by default. |
Value
A list with gender prediction result.
Get Gender by Email (Bulk)
Description
Get Gender by Email (Bulk)
Usage
get_gender_by_email_bulk(api_key, data)
Arguments
api_key |
Your GenderAPI.io API key. |
data |
A list of named lists. Each list can have: - email (string, required) - country (string, optional) - id (string or integer, optional) |
Value
A list with bulk gender prediction results.
Get Gender by Name
Description
Get Gender by Name
Usage
get_gender_by_name(
api_key,
name,
country = NULL,
askToAI = FALSE,
forceToGenderize = FALSE
)
Arguments
api_key |
Your GenderAPI.io API key. |
name |
Name string to check. |
country |
Optional two-letter country code (e.g. "US"). |
askToAI |
Logical. TRUE to force AI lookup, FALSE by default. |
forceToGenderize |
Logical. TRUE to force analysis of nicknames. |
Value
A list with gender prediction result.
Get Gender by Name (Bulk)
Description
Get Gender by Name (Bulk)
Usage
get_gender_by_name_bulk(api_key, data)
Arguments
api_key |
Your GenderAPI.io API key. |
data |
A list of named lists. Each list can have: - name (string, required) - country (string, optional) - id (string or integer, optional) |
Value
A list with bulk gender prediction results.
Get Gender by Username
Description
Get Gender by Username
Usage
get_gender_by_username(
api_key,
username,
country = NULL,
askToAI = FALSE,
forceToGenderize = FALSE
)
Arguments
api_key |
Your GenderAPI.io API key. |
username |
Username string to check. |
country |
Optional two-letter country code (e.g. "US"). |
askToAI |
Logical. TRUE to force AI lookup, FALSE by default. |
forceToGenderize |
Logical. TRUE to force analysis of nicknames. |
Value
A list with gender prediction result.
Get Gender by Username (Bulk)
Description
Get Gender by Username (Bulk)
Usage
get_gender_by_username_bulk(api_key, data)
Arguments
api_key |
Your GenderAPI.io API key. |
data |
A list of named lists. Each list can have: - username (string, required) - country (string, optional) - id (string or integer, optional) |
Value
A list with bulk gender prediction results.