R/genderizeR.R

In kalimu/genderizeR: Gender Prediction Based on First Names

.onAttach <- function(libname, pkgname) {
    
    packageStartupMessage(paste0('\nWelcome to genderizeR package version: ',
                                 utils::packageVersion("genderizeR"))
                          )
    packageStartupMessage("\nHomepage: http://www.wais.kamil.rzeszow.pl/genderizeR")
    
    packageStartupMessage("\nChangelog: news(package = 'genderizeR')")
    packageStartupMessage("Help & Contact: help(genderizeR)")
    
    packageStartupMessage("\nIf you find this package useful cite it please. Thank you! ")
    packageStartupMessage("See: citation('genderizeR')")

    
    packageStartupMessage("\nTo suppress this message use:\nsuppressPackageStartupMessages(library(genderizeR))")        	
			
}


 

#' Gender Prediction Based on First Names
#'
#' The \code{genderizeR} package uses genderize.io API to predict 
#' gender from first names extracted from text corpuses. The accuracy 
#' of prediction could be controlled by two parameters: 
#' counts of first names in database and probability of gender 
#' given the first name.  
#' 
#' If you need help with your research or commercial projects, 
#' feel free to contact me via my homepage contact form: 
#' \url{https://kalimu.github.io/} 
#'
#' @docType package
#' 
#' @name genderizeR
#' 
#'
#' @importFrom magrittr "%>%"
#' @importFrom data.table ":="
#' @import utils
#' 
#' 
#' @seealso 
#' \itemize{
#'   \item \url{https://kalimu.github.io/project/genderizer/} [R package homepage]
#'   \item \url{https://github.com/kalimu/genderizeR} [source code of the latest development version of the R package]
#'   \item \url{http://genderize.io/} [homepage of genderize.io API]
#' }
#' 
# @export
#' 
#@keywords internal
 
NULL
 
# detach("package:genderizeR", unload=TRUE)
# devtools::show_news()