Gendex v0.1.0 Gendex

Gendex is a library that will tell you the most likely gender of a person based on first name.

It uses the underlying data from the program “gender” by Jorg Michael (described here).

Examples

iex> Gendex.lookup("Bob")
:male

iex> Gendex.lookup("Sally")
:female

iex> Gendex.lookup("Pauley")
:unisex

Summary

Functions

Gets the gender of the given name

Checks whether a name exists in Gendex.Names

Functions

lookup(name)

Gets the gender of the given name.

Examples

iex> Gendex.lookup("James")
:male

iex> Gendex.lookup("Unavailable")
:unknown
name_exists?(name)

Checks whether a name exists in Gendex.Names.

Returns true if it exists, otherwise false.

Examples

iex> Gendex.name_exists?("James")
true

iex> Gendex.name_exists?("Unknown")
false