gendercoder: Recodes Sex/Gender Descriptions Into A Standard Set

[ekothe]

Date accepted: 2022-03-08 Submitting Author Name: Emily Kothe Submitting Author Github Handle: !--author1-->@ekothe<!--end-author1-- Other Package Authors Github handles: (comma separated, delete if none) @jlbeaudry, @fsingletonthorn, @rhydwyn, @Lingtax, @njtierney Repository: https://github.com/ropenscilabs/gendercoder Version submitted: 0.0.0.9000. Editor: !--editor-->@ldecicco-USGS<!--end-editor-- Reviewers: @juliasilge, @elinw

Due date for @juliasilge: 2021-05-19 Due date for @elinw: 2021-05-19

Archive: TBD Version accepted: TBD

---

• Paste the full DESCRIPTION file inside a code block below:

Package: gendercoder
Title: Recodes Sex/Gender Descriptions Into A Standard Set
Version: 0.0.0.9000
Authors@R: c(
  person("Jennifer", "Beaudry", role = "aut",
    email = "jbeaudry@swin.edu.au",
    comment = c(ORCID = "https://orcid.org/0000-0003-1596-6708")),
  person("Emily", "Kothe", role = c("aut", "cre"),
    email = "emily.kothe@deakin.edu.au",
    comment = c(ORCID = "https://orcid.org/0000-0003-1210-0554")),
  person("Felix", "Singleton Thorn", role = "aut",
    email = "fsingletonthorn@gmail.com", 
    comment = c(ORCID = "https://orcid.org/0000-0002-0237-6146")),
  person("Rhydwyn", "McGuire", role = "aut",
    email = "rhydwyn@rhydwyn.net"),
  person("Nicholas", "Tierney", 
         role = c("aut"),
         email = "nicholas.tierney@gmail.com", 
         comment = c(ORCID = "https://orcid.org/0000-0003-1460-8722")),
  person("Mathew", "Ling", 
         role = c("aut"),
         email = "mathewtyling@gmail.com", 
         comment = c(ORCID = "https://orcid.org/0000-0002-0940-2538"))       
         )
Description: Provides functions and dictionaries for recoding of freetext gender responses into more consistent categories.
Depends: R (>= 3.0.0)
Maintainer: Emily Kothe <emily.kothe@deakin.edu.au>
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
Imports: 
    purrr
Suggests: 
    testthat (>= 2.1.0),
    knitr,
    rmarkdown,
    dplyr,
    covr
VignetteBuilder: knitr
URL: https://github.com/ropenscilabs/gendercoder
BugReports: https://github.com/ropenscilabs/gendercoder/issues

Scope

• Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):

  • [ ] data retrieval
  • [ ] data extraction
  • [x] data munging
  • [ ] data deposition
  • [ ] workflow automation
  • [ ] version control
  • [ ] citation management and bibliometrics
  • [ ] scientific software wrappers
  • [ ] field and lab reproducibility tools
  • [ ] database software bindings
  • [ ] geospatial data
  • [ ] text analysis

• Explain how and why the package falls under these categories (briefly, 1-2 sentences):

The goal of gendercoder is to allow simple re-coding of free-text gender responses. This is an important data munging task for researchers who collect gender in this format.

• Who is the target audience and what are scientific applications of this package?

Best practice recommendations for the collection of gender information from human participants includes collection of some or all responses in free-text. This allows participants to provide gender responses when their gender is not captured by researcher provided categories (e.g. male, female, non-binary) or when gender is collected without researcher provided categories (e.g. “What is your gender”). gendercoder contains two in-built output dictionaries, a default broad dictionary which corrects spelling and standardises terms while maintaining the diversity of responses and a narrow dictionary which contains only three gender categories, “male”, “female”, and “sex and gender diverse”.

• Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?

To our knowledge this is the only package of its kind.

• (If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?

N/A

• If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.

N/A

Technical checks

Confirm each of the following by checking the box.

• [x] I have read the guide for authors and rOpenSci packaging guide.

This package:

• [x] does not violate the Terms of Service of any service it interacts with.
• [x] has a CRAN and OSI accepted license.
• [x] contains a README with instructions for installing the development version.
• [x] includes documentation with examples for all functions, created with roxygen2.
• [x] contains a vignette with examples of its essential functions and uses.
• [x] has a test suite.
• [x] has continuous integration, including reporting of test coverage using services such as Travis CI, Coveralls and/or CodeCov.

Publication options

• [x] Do you intend for this package to go on CRAN?

• [ ] Do you intend for this package to go on Bioconductor?

• [ ] Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:

MEE Options

- [ ] The package is novel and will be of interest to the broad readership of the journal. - [ ] The manuscript describing the package is no longer than 3000 words. - [ ] You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see [MEE's Policy on Publishing Code](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/journal-resources/policy-on-publishing-code.html)) - (*Scope: Do consider MEE's [Aims and Scope](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/aims-and-scope/read-full-aims-and-scope.html) for your manuscript. We make no guarantee that your manuscript will be within MEE scope.*) - (*Although not required, we strongly recommend having a full manuscript prepared when you submit here.*) - (*Please do not submit your package separately to Methods in Ecology and Evolution*)

Code of conduct

• [x] I agree to abide by rOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

[elinw]

Sorry that it took me a while to respond, but I agree that it's looking great.

[ldecicco-USGS]

Sorry to let this linger so long. I didn't notice that both reviewers replied positively to the updates. @ekothe , there are a few minor questions/comments from @juliasilge above. I think if you take care of those we can move forward with approval!

[ekothe]

Thanks @ldecicco-USGS, @elinw and @juliasilge

I've completed the cleanup tasks suggested by @juliasilge. These have been incorporated as of commit a6e22f9

Can you link to the vignette on how to add a new dictionary in the contributing section of the README?

• Complete

There are some inconsistencies in how manylevels_en and fewlevels_en are referred to in text like the README, both with and without backticks. I'd recommend choosing one and sticking with it.

• Complete. Now using backticks throughout

Why is the example for recode_gender() wrapped in \dontrun{}? It would be better to really run an example to demo on the pkgdown site so folks can see the output. If this was to avoid the pipe, you already have dplyr in Suggests so it should be totally fine. Showing a real example is very useful and should be a high priority; having an example wrapped in \dontrun{} like this will be a "no go" for CRAN.

• Complete. While dplyr is used in suggests, checks failed until I removed the pipe and specified dplyr::mutate() in this example.

You'll need to remove or .Rbuildignore that inst.zip file for CRAN. Or should it go somewhere else? Seems like a weird place to put it.

• Complete. This has been removed.

Do you need readr and rlang in Suggests? I removed them from DESCRIPTION and ran R CMD check and everything seemed fine.

• Complete. These have been removed.

[juliasilge]

This looks great! 🙌

If you wanted to do a tiny bit more clean-up, I would recommend removing the old travis.yml file. However, I approve as is.

[ldecicco-USGS]

@ropensci-review-bot approve gendercoder

[ropensci-review-bot]

Approved! Thanks @ekothe for submitting and @juliasilge, @elinw for your reviews! :grin:

To-dos:

• [ ] Transfer the repo to rOpenSci's "ropensci" GitHub organization under "Settings" in your repo. I have invited you to a team that should allow you to do so.
• [ ] After transfer write a comment @ropensci-review-bot finalize transfer of <package-name> where <package-name> is the repo/package name. This will give you admin access back.
• [ ] Fix all links to the GitHub repo to point to the repo under the ropensci organization.
• [ ] Delete your current code of conduct file if you had one since rOpenSci's default one will apply, see https://devguide.ropensci.org/collaboration.html#coc-file
• [ ] If you already had a pkgdown website and are ok relying only on rOpenSci central docs building and branding,
  • deactivate the automatic deployment you might have set up
  • remove styling tweaks from your pkgdown config but keep that config file
  • replace the whole current pkgdown website with a redirecting page
  • replace your package docs URL with https://docs.ropensci.org/package_name
  • In addition, in your DESCRIPTION file, include the docs link in the URL field alongside the link to the GitHub repository, e.g.: URL: https://docs.ropensci.org/foobar (website) https://github.com/ropensci/foobar
• [ ] Fix any links in badges for CI and coverage to point to the new repository URL.
• [ ] Increment the package version to reflect the changes you made during review. In NEWS.md, add a heading for the new version and one bullet for each user-facing change, and each developer-facing change that you think is relevant.
• [ ] We're starting to roll out software metadata files to all rOpenSci packages via the Codemeta initiative, see https://docs.ropensci.org/codemetar/ for how to include it in your package, after installing the package - should be easy as running codemetar::write_codemeta() in the root of your package.
• [ ] You can add this installation method to your package README install.packages("<package-name>", repos = "https://ropensci.r-universe.dev") thanks to R-universe.

Should you want to acknowledge your reviewers in your package DESCRIPTION, you can do so by making them "rev"-type contributors in the Authors@R field (with their consent).

Welcome aboard! We'd love to host a post about your package - either a short introduction to it with an example for a technical audience or a longer post with some narrative about its development or something you learned, and an example of its use for a broader readership. If you are interested, consult the blog guide, and tag @ropensci/blog-editors in your reply. She will get in touch about timing and can answer any questions.

We maintain an online book with our best practice and tips, this chapter starts the 3d section that's about guidance for after onboarding (with advice on releases, package marketing, GitHub grooming); the guide also feature CRAN gotchas. Please tell us what could be improved.

Last but not least, you can volunteer as a reviewer via filling a short form.

[maelle]

:wave: @ekothe! Is any help needed with the repo transfer? I'm asking as the package will be listed as new package in Friday's newsletter if it's transferred by then. :smile_cat:

[ekothe]

@ropensci-review-bot finalize transfer of gendercoder

[ropensci-review-bot]

Transfer completed. The gendercoder team is now owner of the repository