R/estim_sex.R

In ghesrob/prenomsFR: Prenoms Francais (1900-2018)

#' Estime le sexe d'un individu
#'
#' Estime le sexe d'un individu a partir de son prénom et, optionellement, de sa date de naissance ou de son âge.
#' @param name Un prénom.
#' @param birth_date Date de naissance, au format Date.
#' @param birth_year Année de naissance.
#' @param age Age, en annees.
#' @details
#' Renseigner aucun ou un seul des trois arguments relatifs à la date de naissance.
#' Si aucun n'est renseigné, le sexe est determiné sur la periode 1900-2018.
#' @return Le sexe estimé de l'individu (F/M).
#' @examples
#' estim_sex('Julie', birth_year = 1992)
#' estim_sex('JEAN-JACQUES', age = 59)
#'
estim_sex <- function(name, birth_year = NULL, age = NULL, birth_date = NULL){

  first_name = stringr::str_to_title(name)
  ref_year <- 1900:2018

  if (!missing(birth_year)) {
    ref_year <- birth_year
  } else if (!missing(age)) {
    ref_year <- lubridate::year(Sys.Date() -lubridate:: years(age))
  } else if (!missing(birth_date)) {
    ref_year <- lubridate::year(birth_date)
  }


  prenoms_nat %>%
    filter(
      name == first_name,
      year %in% ref_year
    ) %>%
    group_by(sex) %>%
    summarise(
      n = sum(n)
    ) %>%
    ungroup() %>%
    filter(
      n == max(n)
    ) %>%
    pull(sex)

}