rethnicity

The goal of rethnicity is to provide a method to predict ethnicity from names of people.

WARNING!

I created this package hoping to help applied researchers on their studies regarding ethnic bias and discrimination, and potentially eliminate the racial and ethnic disparities. By using this package, you AGREE to the following:

  1. You understand that the method cannot make predictions 100% correct, and you should be cautious about the results.
  2. You will NOT use this package for purposes other than academic research.
  3. You will NOT disclose the predicted ethnic group to the public, given the names data you might have.
  4. You will NOT discriminate anyone on the basis of race and color, by using the methods provided by this package.
  5. You will not use the information to study individuals, but rather to study populations in the aggregate.

Again, you should use the package responsibly and please refer to the methodology paper for details.

Documentation on Methodology

The complete description of the methodology is on arXiv and published on SoftwareX and please cite it as:

@article{xie2022,
  title = {Rethnicity: {{An R}} Package for Predicting Ethnicity from Names},
  shorttitle = {Rethnicity},
  author = {Xie, Fangzhou},
  year = {2022},
  month = jan,
  journal = {SoftwareX},
  volume = {17},
  pages = {100965},
  issn = {2352-7110},
  doi = {10.1016/j.softx.2021.100965},
}

Installation

I recommend using the wonderful package manager pak to install this package:

# first install `pak` if not yet installed
# install.packages("pak")

# install the CRAN version
pak::pkg_install("rethnicity")

# or install the Github development version
pak::pkg_install("fangzhou-xie/rethnicity")

Of course, you can also install the package in the old way: install the released version of rethnicity from CRAN with:

install.packages("rethnicity")

Or the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("fangzhou-xie/rethnicity")

How to use this package?

There is a vignette that discusses how to use this package.

License

Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

This license was chosen to prohibit commercial usage, while still being free and accessible for non-commercial academic uses.