R/getbase.pob.R

In amvallone/DataSpa: Collect Spanish data at municipality level

#' @name getbase.pob
#' @rdname getbase.pob
#'
#' @title Collects information of population at a municipality level.
#'
#' @description \code{getbase.pob} downloads population data of the Spanish municipalities by province. 
#'
#' @param year a numerical value from 1996 and the latest available, which indicates the year of the required database.
#' @param provincia one of the 52 Spainish province.
#' @param extr logical variable ‘is it foreign population?’ FALSE is the default value.
#' @param anual logical variable ‘is data required by age?’ FALSE is the default value.
#'
#' @return It is a \code{xlsx} which is host in  the \code{data_poblacion} which, in turn, is located inside the working directory called \code{pob_q_year_provincia.xls}. If \code{extr} is TRUE, the file is called \code{pob_e_year_provincia.xls}. In case of \code{anual} is TRUE the file is called \code{pob_a_year_provincia.xls}. There is not data for foreign population by one or five-year age, the combination of \code{extr=TRUE} and \code{anual=TRUE will} generate an error message (“No data for these cases”).
#' 
#' @details The names of the Spanish provinces may or may not be called. If yes, employ capital letters as follows:
#'	
#' "ALBACETE", "ALICANTE", "ALMERIA", "ARABA", "ASTURIAS", "AVILA", "BADAJOZ", "BALEARES", "BARCELONA", "BIZKAIA", "BURGOS", "CACERES", "CADIZ", "CANTABRIA", "CASTELLON", "CIUDAD REAL", "CORDOBA", "A CORUÑA", "CUENCA", "GIPUZKOA", "GIRONA", "GRANADA", "GUADALAJARA", "HUELVA", "HUESCA", "JAEN", "LEON", "LLEIDA", "LUGO", "MADRID", "MALAGA", "MURCIA", "NAVARRA", "OURENSE", "PALENCIA",  "LAS PALMAS", "PONTEVEDRA", "LA RIOJA", "SALAMANCA", "TENERIFE", "SEGOVIA", "SEVILLA","SORIA", "TARRAGONA", "TERUEL", "TOLEDO", "VALENCIA", "VALLADOLID", "ZAMORA", "ZARAGOZA", "CEUTA" and "MELILLA"
#'
#' @family download functions
#' @examples
#' getbase.pob(2005,"Madrid")
#'
#' @export


getbase.pob<-function(year,provincia,extr=FALSE,anual=FALSE){
		year<-as.character(year)
		if(extr==TRUE && anual==TRUE) stop("No data for these cases")
		if(anual==TRUE && as.numeric(year)<2011) stop("No data for these cases")
		provincia<-toupper(provincia)
		provincia<-a.letter(provincia)
		if(dir.exists(file.path(getwd(),"data_poblacion"))==FALSE){
		dir.create(file.path(getwd(),"data_poblacion"))
		}
		if (extr==TRUE) {
			if(as.numeric(year)<2002) {q<-4} else {q<-2}
			e<-"e"
			} else {
			q<-1
			e<-"q"
			}
		if (anual==TRUE) { q<-6; e<-"a"}
		file<-paste(getwd(),"/data_poblacion/",paste("pob",e,year,provincia,sep="_"),".xlsx",sep="")
		p<-c("02","03","04","01","33","05","06","07","08","48","09","10","11","39","12","13","14","15","16","20","17","18","19","21","22","23","24","25","27","28","29","30","31","32","34","35","36","26","37","38","40","41","42","43","44","45","46","47","49","50","51","52")
		names(p) <- c("ALBACETE","ALICANTE","ALMERIA","ARABA","ASTURIAS","AVILA","BADAJOZ","BALEARES","BARCELONA","BIZKAIA","BURGOS","CACERES","CADIZ","CANTABRIA","CASTELLON","CIUDAD_REAL","CORDOBA","A_CORUNA","CUENCA","GIPUZKOA","GIRONA","GRANADA","GUADALAJARA","HUELVA","HUESCA","JAEN","LEON","LLEIDA","LUGO","MADRID","MALAGA","MURCIA","NAVARRA","OURENSE","PALENCIA","LAS_PALMAS","PONTEVEDRA","LA_RIOJA","SALAMANCA","TENERIFE","SEGOVIA","SEVILLA","SORIA","TARRAGONA","TERUEL","TOLEDO","VALENCIA","VALLADOLID","ZAMORA","ZARAGOZA","CEUTA","MELILLA")
		n<-p[provincia]
		url<-paste("http://www.ine.es/jaxi/files/_px/es/xlsx/t20/e245/p05/a",year,"/l0/000",n,"00",q,".px?nocab=1",sep="")
		print(url)
		download.file(url,file,, mode='wb')
}