Repository files navigation

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

I created this package hoping to help applied researchers on theirstudies regarding ethnic bias and discrimination, and potentiallyeliminate the racial and ethnic disparities. By using this package, youAGREE to the following:

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

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

The complete description of the methodology is onarXiv and published onSoftwareX and please citeit 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},}

I recommend using the wonderful package managerpak to install this package:

# first install `pak` if not yet installed# install.packages("pak")# install the CRAN versionpak::pkg_install("rethnicity")# or install the Github development versionpak::pkg_install("fangzhou-xie/rethnicity")

Of course, you can also install the package in the old way: install thereleased version of rethnicity fromCRANwith:

install.packages("rethnicity")

Or the development version fromGitHub with:

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

There is avignettethat discusses how to use this package.

Creative Commons Attribution-NonCommercial-ShareAlike 4.0 InternationalLicense.

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