R/get.ASCII.file.header.R

In AWAPer: Catchment Area Weighted Climate Data Anywhere in Australia

#' \code{get.ASCII.file.header} get header information.
#'
#' This is an internal function. It returns the header information within a ARCMAP ASCII grid file.
#'
#' @return
#' A list variable of header information.
#'
#' @keywords internal
#'
#' @export
get.ASCII.file.header <- function (data.type.label, workingFolder, datestring, remove.file=T) {

  OS <- Sys.info()
  OS <- OS[1]
  if (OS=='Windows') {
    #system(paste('7z e -aoa -bso0 ',des.file.name))
    des.file.name = file.path(workingFolder,paste(data.type.label,datestring,'.grid',sep=''))
    raw<-textConnection(readLines(a<-file(des.file.name)))
  } else {
    #system(paste('znew -f ',des.file.name))
    des.file.name = file.path(workingFolder,paste(data.type.label,datestring,'.grid.gz',sep=''))
    raw<-textConnection(readLines(a<-gzfile(des.file.name)))
  }

  headerData = readLines(raw,n=6)
  nCols =as.integer(sub('ncols', '', headerData[1]))
  nRows = as.integer(sub('nrows', '', headerData[2]));
  SWLong = as.numeric(sub('xllcenter', '', headerData[3]));
  SWLat = as.numeric(sub('yllcenter', '', headerData[4]));
  DPixel = as.numeric(sub('cellsize', '', headerData[5]));
  nodata = as.numeric(sub('nodata_value', '', headerData[6]));

  close(a)
  close(raw)
  if (remove.file) {
    message(paste('... Deleting',des.file.name))
    didRemoveFile = tryCatch({file.remove(des.file.name)},finally=TRUE)
  }

  header.data =  list(nCols=nCols,nRows=nRows,SWLong=SWLong,SWLat=SWLat,DPixel=DPixel,nodata=nodata)
  return(header.data)
}