R/FFCSV.evalSpacing.r

In arnhew99/Jasper: Jasper makes plots

FFCSV.evalSpacing <- function(mainfont,
								orient,
								type, 
								filestem, 
								blank.right.percent, 
								blank.left.percent,
								blank.bottom.percent,
								page_width,
								page_height,
								mar,
								rawdata,
								col.ids = -1,
								print.headings="",
								plot.width = 0,
								nforests = 0,
								anyhets = 0,
								HetTrendScale=0.8,
								spacing.text = "a",
								spacing.cex=1,
								coldp_names=NULL,
								coldp_dps=NULL,
								pvalue.cols=NULL,
								ValueDigits=NULL) 
	{
								
	SetPage(orient=orient, perpage=1, type=type, filestem=filestem, 
			page_width=page_width, page_height=page_height,
			blank.right.percent=blank.right.percent, blank.bottom.percent=blank.bottom.percent, blank.left.percent=blank.left.percent, 
			verbose=FALSE, attempt_adobe_kill=FALSE)
	par(mar=mar)
	blankPlot(c(0,100), c(0,100), mainfont)
	par(xpd=NA)		
	# need to use the formatted versions of the column headings where ";" has been substituted for "\n"
	if (col.ids[1] == -1) {
		other.cols.widths <- 0 
	} else {
		other.cols.widths <- sapply(col.ids, function(z) FFCSV.findColWidth(column=rawdata[,z], heading=print.headings[z], colname=names(rawdata)[z], coldp_names=coldp_names, coldp_dps=coldp_dps, pvalue.cols=pvalue.cols))
	}
	
	# plotlabel.width <- max(strwidth("0.00 (-0.00,-0.00)", cex=1, font=2), anyhets*strwidth("Heterogeneity: AI=3.7 (p=0.0001)", cex=1*HetTrendScale)) # second part is 0 if there are no tests
	plotlabel.width <- max(strwidth(makeBlankValueLabel(digits=ValueDigits), cex=1, font=2), anyhets*strwidth("Heterogeneity: AI=3.7 (p=0.0001)", cex=1*HetTrendScale)) # second part is 0 if there are no tests
	
	all.widths <- c(other.cols.widths, nforests*plot.width, nforests*plotlabel.width)
	#print(all.widths)
	n.cols <- ifelse(col.ids == -1, 0, length(col.ids))
	
	# we give 0.5 of a spacing to the gap between the forest and the label
	spacing <- (100 - sum(all.widths)) / (length(n.cols)+(nforests*1.5))
	
	a.width <- strwidth(spacing.text, cex=spacing.cex)
	closeFile("PDF", suppress.notice=TRUE)
	
	return(c(spacing, spacing-a.width))
}

FFCSV.findColWidth <- function(column, heading, colname, coldp_names=NULL, coldp_dps=NULL, pvalue.cols=NULL) {

	# these lines left commented because debugging this is painful
	# print(colname)
	# print(pvalue.cols)
	# print(cbind(c(column, heading), sapply(convertUnicode(as.character(c(column, heading))), strwidth, font=2, cex=1)))
	if (all(!is.null(pvalue.cols), colname %in% pvalue.cols)) {
		# print("this is to be formatted as a pvalue column")
		return_width <- max(strwidth("<1\u00d710 ", font=2, cex=1), strwidth(convertUnicode(heading), font=2, cex=1))
	}
	else if (all(!is.null(coldp_names), !is.null(coldp_dps), colname %in% coldp_names)) {
		# print("this column is converted to use a certain DP")
		# find out which dp we are using 
		cdp <- coldp_dps[which(coldp_names == colname)]
		return_width <- max(sapply(c(sprintf(paste0("%.", cdp, "f"), column), convertUnicode(heading)), strwidth, font=2, cex=1))
	} else {
		return_width <- max(sapply(convertUnicode(as.character(c(column, heading))), strwidth, font=2, cex=1))
	}

	# print("return width is")
	# print(return_width)
	return(return_width)	

}


FFCSV.evalLabelSpacing <- function(mar.test, current.mar, ylocs, orient, mainfont, type, filestem, blank.right.percent, blank.left.percent, blank.bottom.percent, page_width, page_height, titlespace, footerspace) {

	new.mar <- c(mar.test,current.mar[2], mar.test, current.mar[4])
	SetPage(orient=orient, perpage=1, type=type, filestem=filestem, 
			blank.right.percent=blank.right.percent, blank.left.percent=blank.left.percent, blank.bottom.percent=blank.bottom.percent, 
			page_width=page_width, page_height=page_height, 
			verbose=FALSE, titlespace=titlespace, footerspace=footerspace, attempt_adobe_kill=FALSE)
	par(mar=new.mar)
	blankPlot(c(0,100), c(0,100), mainfont)
	par(xpd=NA)		

	
	max.heading.height <- strheight("A sentence with a y and a CAPITAL", font=2)
	
	# want to know the smallest difference between vertically neighbouring labels
	min.heading.gap <- min(abs(diff(ylocs)))
	
	line.gap <- (strheight("A\nA") - strheight("M"))

	closeFile("PDF", suppress.notice=TRUE)
	
	return(c(max.heading.height, min.heading.gap, line.gap))
	
}

FFCSV.optimise.linespace <- function(current.mar, line.spacing, ylocs, orient, mainfont, type, filestem, blank.right.percent, blank.left.percent, blank.bottom.percent, page_width, page_height, titlespace, footerspace) 
{

	# function to optimise over
	optim.TBmargin.fn <- function(z) {
		spac <- FFCSV.evalLabelSpacing(mar.test=z, current.mar=current.mar, ylocs=ylocs, orient=orient, 
										mainfont=mainfont, type=type, filestem=filestem, 
										blank.right.percent=blank.right.percent, blank.left.percent=blank.left.percent, blank.bottom.percent=blank.bottom.percent, 
										page_width=page_width, page_height=page_height, 
										titlespace=titlespace, footerspace=footerspace)
		# return(abs(spac[2] - (spac[1]*ifelse(mainfont < 1.5, 1.5, mainfont)*line.spacing)))
		return(abs(spac[2] - line.spacing*spac[3]))
	}
	optim.TBmargin <- optimise(f=optim.TBmargin.fn, interval=c(0,min(30,30/mainfont)), maximum=FALSE)
	return(optim.TBmargin)

}