R/ipumsPMA-package.R

In mgunther87/ipumsPMA: Common functions for IPUMS PMA staff

#' @title ipumsPMA
#' @description Custom workflow functions for IPUMS PMA staff. 
#' See \url{https://pages.github.umn.edu/gunth031/ipumsPMA/} for
#' full documentation.
#' 
#' @details CAUTION: ipumsPMA contains several package 
#' dependencies, so update / new installation may be required.
#' 
#' In particular: ipumsPMA requires use of the ipums.metadata 
#' Python library wrapped for R via the "reticulate" package. 
#' See \url{https://github.umn.edu/gunth031/ipumsPMA} for 
#' details on setup.
#' 
#' 
#' @seealso \code{
#' \link{config_make}
#' \link{datgz_get}
#' \link{dd_get}
#' \link{dds_list}
#' \link{desc_fix}
#' \link{desc_get}
#' \link{desc_make}
#' \link{dtag_shiny}
#' \link{enum_get}
#' \link{enum_make}
#' \link{enums_list}
#' \link{jtag_shiny}
#' \link{odk_get}
#' \link{py}
#' \link{reformatted_get}
#' \link{svars_by_tt}
#' \link{tracking_get}
#' \link{tt_get}
#' \link{tt_fix}
#' \link{tts_list}
#' \link{tt_make}
#' \link{tt_to_xls}
#' \link{tt_update}
#' }
#' @name ipumsPMA-package
#' @aliases ipumsPMA-package ipumsPMA
#' @docType package
#' @author Matt Gunther

NULL


#' @title ipums-metadata Python module wrapper for R
#' 
#' @description Upon loading the ipumsPMA package, py loads
#' automatically as a Python module in the user's workspace. 
#' py uses the \href{https://rstudio.github.io/reticulate/index.html}{reticulate} package to load Python functions 
#' for accessing sequestered metadata in PMA (or other ipums 
#' projects). The functions are documented at the 
#' \href{https://github.umn.edu/mpc/ipums-metadata}{ipums-metadata} GitHub page.
#' 
#' @note ipumsPMA will not function if a conda environment 
#' containing the ipums-metadata package has not been 
#' previously installed by the user! See package home page for 
#' setup instructions.
#' 
#' @name py
#' @docType data
#' @export py
NULL