R/describeRel.R

In CommerceDataService/eu.us.opendata: A library for bringing together EU and US statistical data

#' Given a relationship ID, return description of mapped relationship allowing users to see common overlap and/or differences between datasets
#' 
#' @param term 	 ID of the statistic requested 
#' @param asHtml  Option to render results in an interactive DT
#' @import data.table formattable
#' @export 

describeRel <- function(term, asHtml = TRUE) { 
	requireNamespace('data.table', quietly = TRUE)
	requireNamespace('formattable', quietly = TRUE)

	eu.us.opendata::updateCache();
	
  localRel <- as.data.frame(loadLocalRel())
  loc = localRel[localRel$Rel_ID==term,]
  
  if(nrow(loc)>0){
	  a <- data.frame(field = c("EU US Rel_ID","Description","freq", "period","unit","geo", "url"),
	                 EU_data = c(loc$Rel_ID,loc$Rel_name,loc$Freq,loc$EU_Period,loc$EU_Unit,loc$EU_Geo,loc$EU_ID),
	                 US_data = c("","",loc$Freq,loc$BEA_Period,loc$BEA_Unit,loc$BEA_Geo,loc$BEA_ID))
	  colnames(a) <- c("Field", "EU Data","US Data")
	  if(asHtml == TRUE){
		  formattable::formattable(a, align="l")
		} else {
		  return(a);
		}
  } else{
    print("No result")
  }
}

#Example
#describeRel("JOINT#GDP_A_2") #matched case
#describeRel("gdp") #error case