From 653543b7c72c696dd84fef9795f2380e29cef071 Mon Sep 17 00:00:00 2001 From: Christy Rollinson Date: Mon, 18 Sep 2017 10:03:00 -0500 Subject: [PATCH] Update documentation --- modules/data.atmosphere/NAMESPACE | 1 + .../man/extract.local.NLDAS.Rd | 42 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 modules/data.atmosphere/man/extract.local.NLDAS.Rd diff --git a/modules/data.atmosphere/NAMESPACE b/modules/data.atmosphere/NAMESPACE index 82a3283fa04..47c2f36f621 100644 --- a/modules/data.atmosphere/NAMESPACE +++ b/modules/data.atmosphere/NAMESPACE @@ -32,6 +32,7 @@ export(download.PalEON_ENS) export(equation_of_time) export(exner) export(extract.local.CMIP5) +export(extract.local.NLDAS) export(extract.nc) export(gen.subdaily.models) export(get.es) diff --git a/modules/data.atmosphere/man/extract.local.NLDAS.Rd b/modules/data.atmosphere/man/extract.local.NLDAS.Rd new file mode 100644 index 00000000000..e4291992863 --- /dev/null +++ b/modules/data.atmosphere/man/extract.local.NLDAS.Rd @@ -0,0 +1,42 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/extract_local_NLDAS.R +\name{extract.local.NLDAS} +\alias{extract.local.NLDAS} +\title{extract.local.NLDAS} +\usage{ +extract.local.NLDAS(outfolder, in.path, start_date, end_date, site_id, lat.in, + lon.in, overwrite = FALSE, verbose = FALSE, ...) +} +\arguments{ +\item{outfolder}{- directory where output files will be stored} + +\item{in.path}{- path to the raw full grids} + +\item{start_date}{- first day for which you want to extract met (yyyy-mm-dd)} + +\item{end_date}{- last day for which you want to extract met (yyyy-mm-dd)} + +\item{site_id}{name to associate with extracted files} + +\item{lat.in}{site latitude in decimal degrees} + +\item{lon.in}{site longitude in decimal degrees} + +\item{overwrite}{logical. Download a fresh version even if a local file with the same name already exists?} + +\item{...}{Other arguments, currently ignored} +} +\description{ +This function extracts NLDAS data from grids that have been downloaded and stored locally. + Once upon a time, you could query these files directly from the internet, but now they're + behind a tricky authentication wall. Files are saved as a netCDF file in CF conventions. + These files are ready to be used in the general PEcAn workflow or fed into the downscalign + workflow. +} +\details{ +Extract NLDAS from local download +Extract NLDAS meteorology for a poimt from a local download of the full grid +} +\author{ +Christy Rollinson, +}