namespace update

DESCRIPTION

@@ -9,7 +9,7 @@ Description: Functions to read and plot netcdf climate data, and compare NPP
 License: GPL-3
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Depends:
   RColorBrewer,
   ncdf4

NAMESPACE

 # Generated by roxygen2: do not edit by hand
 
-export(LPJ_datatype)
-export(LpjmlMetaData)
-export(aggregateLPJmLdata2Country)
-export(asub)
-export(autoReadInput)
-export(autoReadMetaOutput)
-export(autoReadclmOutput)
-export(auto_read_nc)
-export(calcCellarea)
-export(calcEFRs)
-export(create_header)
-export(daily2monthly)
-export(evenGrid2lpjGrid)
-export(exportVars2GlobalEnv)
-export(flowSeason)
-export(freadheader)
-export(fwriteheader)
-export(get_datatype)
-export(headersize)
-export(lpj2raster)
-export(lpjCOW)
-export(lpj_datatype)
-export(mapBetweenLPJgrids)
-export(monthly2yearly)
-export(netcdfCFT2lpjarray)
-export(netcdfDaily2lpjarray)
-export(netcdfMonthly2lpjarray)
-export(netcdfYearly2lpjarray)
-export(new_header)
-export(pie2)
-export(plotBasin2screen)
-export(plotCountryData)
-export(plotGlobal)
-export(plotGlobalFlex)
-export(plotGlobalMan)
-export(plotGlobalManToScreen)
-export(plotGlobalToScreen)
-export(plotLUshares)
-export(plotLUsharesToScreen)
-export(plotLocations)
-export(plotLocationsToScreen)
-export(plotMonth)
-export(plotRegionalW)
-export(plotTimelines)
-export(plotToScreen)
-export(plot_relDiff)
-export(printLegend)
-export(readCFTinput)
-export(readCFToutput)
-export(readDaily)
-export(readGridInputBin)
-export(readGridOutputBin)
-export(readGridOutputNC)
-export(readMonthly)
-export(readMonthlyCFToutput)
-export(readNCoutput)
-export(readReservoirInput)
-export(readYearly)
-export(readYearlyInput)
-export(read_header)
-export(read_meta)
-export(readheader2)
-export(removeHighFlows)
-export(replace_array)
-export(showRoute)
-export(subset_array)
-export(upstreamCells)
-export(writeNETCDFfromLPJ)
-export(writeWUinput)
-export(write_climate_input)
-export(write_landuse_input)
-export(writeheader)
+export(add_modelled_npp_to_zhang_npp_measurements)
+export(climate_plot)
+export(get_main_variable)
+export(get_netcdf_cellsize)
+export(get_timestep)
+export(plot_lon_lat_array)
+export(read_in_zhang_file)
+export(read_netcdf)
+export(scatter_plot)

man/add_modelled_npp_to_zhang_npp_measurements.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{add_modelled_npp_to_zhang_npp_measurements}
+\alias{add_modelled_npp_to_zhang_npp_measurements}
+\title{Add modelled NPP to measured zhang data}
+\usage{
+add_modelled_npp_to_zhang_npp_measurements(zhang_data, modelled_npp)
+}
+\arguments{
+\item{zhang_data}{zhang data list object 
+(e.g. obtained from read_in_zhang_file() function)}
+
+\item{modelled_npp}{array with modelled NPP (dimensions [lat,lon,year])}
+}
+\value{
+modified zhang_data input list, with added colums: measured, modelled
+}
+\description{
+Add the best fitting modelled NPP to the measured zhang data list object 
+(e.g. obtained from read_in_zhang_file() function)
+}
+\examples{
+\dontrun{
+}
+
+}

man/climate_plot.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{climate_plot}
+\alias{climate_plot}
+\title{Plot the climate of a given location}
+\usage{
+climate_plot(temp, prec, file = NULL, title = "")
+}
+\arguments{
+\item{file}{character path. file location to save the plot to. 
+If not supplied prints to screen. Default: NULL}
+
+\item{title}{character string printed as title.}
+
+\item{tmp}{temperature array with 12 values for each month in °C}
+
+\item{pre}{precipitation array with 12 values for each month in mm}
+}
+\value{
+None
+}
+\description{
+Plot an array of lon_lat data to screen or file 
+e.g. obtained from read_netcdf and averaged over time.
+Prints to screen if file argument is not supplied (default).
+}
+\examples{
+\dontrun{
+}
+
+}

man/get_main_variable.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{get_main_variable}
+\alias{get_main_variable}
+\title{Get main variable of a netcdf file}
+\usage{
+get_main_variable(file_nc)
+}
+\arguments{
+\item{file_nc}{netcdf file name}
+}
+\value{
+character string: determined main variable name
+}
+\description{
+Utility function to guess the main variable of a netcdf file
+}
+\examples{
+\dontrun{
+}
+
+}

man/get_netcdf_cellsize.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{get_netcdf_cellsize}
+\alias{get_netcdf_cellsize}
+\title{Returns cellarea of given netcdf in m}
+\usage{
+get_netcdf_cellsize(nc_in_file = tmp_file)
+}
+\arguments{
+\item{nc_in_file}{netcdf file name}
+}
+\value{
+cellarea array with dimensions [longitude, latitude] in m
+}
+\description{
+Returns approximate cellarea of given netcdf file in m
+}
+\examples{
+\dontrun{
+}
+
+}

man/get_timestep.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{get_timestep}
+\alias{get_timestep}
+\title{Get time resolution of a netcdf file}
+\usage{
+get_timestep(file_nc)
+}
+\arguments{
+\item{file_nc}{netcdf file name}
+}
+\value{
+character string: determined timestep (daily, monthly, yearly)
+}
+\description{
+Utility function to determine time resolution of a netcdf file
+}
+\examples{
+\dontrun{
+}
+
+}

man/plot_lon_lat_array.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{plot_lon_lat_array}
+\alias{plot_lon_lat_array}
+\title{Plot an array of lon_lat data to screen or file}
+\usage{
+plot_lon_lat_array(data, file = NULL, title = "")
+}
+\arguments{
+\item{data}{array to plot. Needs to be in format [longitude,latitude].}
+
+\item{file}{character path. file location to save the plot to. 
+If not supplied prints to screen. Default: NULL}
+
+\item{title}{character string printed as title.}
+}
+\value{
+None
+}
+\description{
+Plot an array of lon_lat data to screen or file 
+e.g. obtained from read_netcdf and averaged over time.
+Prints to screen if file argument is not supplied (default).
+}
+\examples{
+\dontrun{
+}
+
+}

man/read_in_zhang_file.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{read_in_zhang_file}
+\alias{read_in_zhang_file}
+\title{Read in the Zhang et al. csv file with NPP measurements}
+\usage{
+read_in_zhang_file(csv_in_file)
+}
+\arguments{
+\item{csv_in_file}{character string. full csv file path}
+}
+\value{
+list object with dimensions [lat, lon, totnpp, year] per record
+}
+\description{
+Read in the Zhang et al. csv file with NPP measurements and return a 
+list of relevant records
+}
+\examples{
+\dontrun{
+}
+
+}

man/read_netcdf.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{read_netcdf}
+\alias{read_netcdf}
+\title{Reads netcdf and returns the requested variable as an array}
+\usage{
+read_netcdf(
+  nc_in_file,
+  var = NULL,
+  get_year_start = NULL,
+  get_year_stop = NULL,
+  suppress_read_print = FALSE
+)
+}
+\arguments{
+\item{nc_in_file}{netcdf file name}
+
+\item{var}{optional variable to be read, in case automatic detection does 
+not work as intended or several variables are stored within the file}
+
+\item{get_year_start}{first year to be read 
+(if not specified will default to first record year)}
+
+\item{get_year_stop}{final year to be read 
+(if not specified will default to last record year)}
+
+\item{suppress_read_print}{whether to suppress the info "reading file XYZ" 
+(default FALSE)}
+}
+\value{
+array with netcdf's data, dim=c([longitude],[latitude],[bands],[months],[years])
+}
+\description{
+Reads an arbitrary netcdf and returns the requested variable in the given 
+year range as an array
+}
+\examples{
+\dontrun{
+}
+
+}

man/scatter_plot.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/clews.R
+\name{scatter_plot}
+\alias{scatter_plot}
+\title{Create a scatterplot}
+\usage{
+scatter_plot(x, y, file = NULL, title = "", xlab = "", ylab = "")
+}
+\arguments{
+\item{x}{data to plot on x axis}
+
+\item{y}{data to plot on y axis}
+
+\item{file}{character path. file location to save the plot to. 
+If not supplied prints to screen. Default: NULL}
+
+\item{title}{character string printed as title.}
+
+\item{xlab}{label for x axis}
+
+\item{ylab}{label for y axis}
+}
+\value{
+None
+}
+\description{
+Create a scatterplot of two data series e.g. measured vs. modelled
+}
+\examples{
+\dontrun{
+}
+
+}