rethnicity

predict ethnicity from names

https://github.com/fangzhou-xie/rethnicity

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README
✓
Academic publication links
Links to: arxiv.org
✓
Committers with academic emails
3 of 4 committers (75.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.2%) to scientific vocabulary

Keywords

cran ethnicity-classifier ethnicity-prediction lstm r

Last synced: 6 months ago · JSON representation

Repository

predict ethnicity from names

Basic Info

Host: GitHub
Owner: fangzhou-xie
Language: C++
Default Branch: main
Homepage: https://fangzhou-xie.github.io/rethnicity
Size: 3.27 MB

Statistics

Stars: 11
Watchers: 3
Forks: 2
Open Issues: 3
Releases: 4

Topics

cran ethnicity-classifier ethnicity-prediction lstm r

Created over 4 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

```{r, echo = FALSE, results = "hide", message = FALSE}
library(badger)
```

# rethnicity


```{r, echo = FALSE, results = "asis"}
cat(
  badge_doi("10.1016/j.softx.2021.100965", "yellow"),
  badge_lifecycle("stable"),
  badge_cran_release("rethnicity", "green"),
  badge_cran_download("rethnicity", "grand-total", "green"),
  badge_cran_checks("rethnicity"),
  badge_github_actions("fangzhou-xie/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](#documentation-on-methodology) for details.

## Documentation on Methodology {#documentation-on-methodology}

The complete description of the methodology is on [arXiv](https://arxiv.org/abs/2109.09228) and published on [SoftwareX](https://doi.org/10.1016/j.softx.2021.100965) 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`](https://github.com/r-lib/pak) to install this package:

``` r
# 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](https://CRAN.R-project.org) with:

``` r
install.packages("rethnicity")
```

Or the development version from [GitHub](https://github.com/) with:

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

## How to use this package?

There is a [vignette](https://fangzhou-xie.github.io/rethnicity/articles/introduction.html) that discusses how to use this package.

## License

[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).

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

Owner

Name: Fangzhou Xie
Login: fangzhou-xie
Kind: user

Website: https://fangzhou-xie.github.io/
Repositories: 6
Profile: https://github.com/fangzhou-xie

GitHub Events

Total

Issues event: 1
Watch event: 2
Issue comment event: 1
Push event: 22

Last Year

Issues event: 1
Watch event: 2
Issue comment event: 1
Push event: 22

Committers

Last synced: over 2 years ago

All Time

Total Commits: 35
Total Committers: 4
Avg Commits per committer: 8.75
Development Distribution Score (DDS): 0.286

Past Year

Commits: 7
Committers: 1
Avg Commits per committer: 7.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
fangzhou-xie	f**e@n**u	25
fangzhou-xie	f**e@r**u	8
tnagler	m**l@t**m	1
mark-fangzhou-xie	4****e	1

Committer Domains (Top 20 + Academic)

tnagler.com: 1 rutgers.edu: 1 nyu.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 8
Total pull requests: 1
Average time to close issues: 6 months
Average time to close pull requests: 32 minutes
Total issue authors: 5
Total pull request authors: 1
Average comments per issue: 2.63
Average comments per pull request: 1.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 0
Average time to close issues: 8 days
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 0
Average comments per issue: 0.5
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

fangzhou-xie (3)
MrMatsson (2)
MataEE (1)
Lukaku92 (1)

Pull Request Authors

tnagler (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 287 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 8
Total maintainers: 1

cran.r-project.org: rethnicity

Predicting Ethnic Group from Names

Homepage: https://github.com/fangzhou-xie/rethnicity
Documentation: http://cran.r-project.org/web/packages/rethnicity/rethnicity.pdf
License: CC BY-NC-SA 4.0
Latest release: 0.2.7
published 12 months ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 287 Last month

Rankings

Forks count: 14.9%

Stargazers count: 21.1%

Average: 26.4%

Dependent packages count: 29.8%

Downloads: 30.9%

Dependent repos count: 35.5%

Maintainers (1)

fangzhou.xie@rutgers.edu

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

R >= 3.4.0 depends
Rcpp * imports
cli * imports
knitr * suggests
magrittr * suggests
parallel * suggests
rmarkdown * suggests
testthat >= 3.0.0 suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

rethnicity

Science Score: 59.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.Rmd

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: rethnicity

Rankings

Maintainers (1)

Dependencies