From 2df3df0f30aeeb9092e441df9bd95dfebfad3234 Mon Sep 17 00:00:00 2001 From: Chris Black Date: Mon, 24 Jul 2017 12:59:34 -0400 Subject: [PATCH 1/2] Show correct format for pecan.clowder.xml --- modules/data.atmosphere/R/download.Geostreams.R | 17 ++++++++++++++++- .../data.atmosphere/man/download.Geostreams.Rd | 17 ++++++++++++++++- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/modules/data.atmosphere/R/download.Geostreams.R b/modules/data.atmosphere/R/download.Geostreams.R index 73a60279234..ff71798536b 100644 --- a/modules/data.atmosphere/R/download.Geostreams.R +++ b/modules/data.atmosphere/R/download.Geostreams.R @@ -1,7 +1,7 @@ #' Download Geostreams data from Clowder API #' #' @param outfolder directory in which to save json result. Will be created if necessary -#' @param sitename character. Should match a geostreams sensor_name +#' @param sitename character. Must match a Geostreams sensor_name #' @param start_date,end_date datetime #' @param url base url for Clowder host #' @param key,user,pass authentication info for Clowder host. @@ -13,6 +13,21 @@ #' `~/.pecan.clowder.xml`, and finally if no keys or passwords are found there it #' attempts to connect unauthenticated. #' +#' If using `~/.pecan.clowder.xml`, it must be a valid PEcAn-formatted XML settings +#' file and must contain a \code{} key that specifies hostname, user, and +#' password for your Clowder server: +#' +#' \code{\preformatted{ +#' +#' +#' +#' terraref.ncsa.illinois.edu +#' yourname +#' superSecretPassw0rd +#' +#' +#' }} +#' #' @export #' @author Harsh Agrawal, Chris Black #' @examples \dontrun{ diff --git a/modules/data.atmosphere/man/download.Geostreams.Rd b/modules/data.atmosphere/man/download.Geostreams.Rd index d450f354908..aa105db6df0 100644 --- a/modules/data.atmosphere/man/download.Geostreams.Rd +++ b/modules/data.atmosphere/man/download.Geostreams.Rd @@ -11,7 +11,7 @@ download.Geostreams(outfolder, sitename, start_date, end_date, \arguments{ \item{outfolder}{directory in which to save json result. Will be created if necessary} -\item{sitename}{character. Should match a geostreams sensor_name} +\item{sitename}{character. Must match a Geostreams sensor_name} \item{start_date, end_date}{datetime} @@ -31,6 +31,21 @@ Depending on the setup of your Clowder host, authentication may be by then if these are NULL it looks in the user's home directory for a file named `~/.pecan.clowder.xml`, and finally if no keys or passwords are found there it attempts to connect unauthenticated. + +If using `~/.pecan.clowder.xml`, it must be a valid PEcAn-formatted XML settings + file and must contain a \code{} key that specifies hostname, user, and + password for your Clowder server: + +\code{\preformatted{ + + + + terraref.ncsa.illinois.edu + yourname + superSecretPassw0rd + + +}} } \examples{ \dontrun{ From fde9706453ff316d64267d527002935f19eed54f Mon Sep 17 00:00:00 2001 From: Chris Black Date: Mon, 24 Jul 2017 14:06:37 -0400 Subject: [PATCH 2/2] typo --- modules/data.atmosphere/R/download.Geostreams.R | 2 +- modules/data.atmosphere/man/download.Geostreams.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/data.atmosphere/R/download.Geostreams.R b/modules/data.atmosphere/R/download.Geostreams.R index ff71798536b..8b1e9ca9108 100644 --- a/modules/data.atmosphere/R/download.Geostreams.R +++ b/modules/data.atmosphere/R/download.Geostreams.R @@ -18,7 +18,7 @@ #' password for your Clowder server: #' #' \code{\preformatted{ -#' +#' #' #' #' terraref.ncsa.illinois.edu diff --git a/modules/data.atmosphere/man/download.Geostreams.Rd b/modules/data.atmosphere/man/download.Geostreams.Rd index aa105db6df0..4854cce420f 100644 --- a/modules/data.atmosphere/man/download.Geostreams.Rd +++ b/modules/data.atmosphere/man/download.Geostreams.Rd @@ -37,7 +37,7 @@ If using `~/.pecan.clowder.xml`, it must be a valid PEcAn-formatted XML settings password for your Clowder server: \code{\preformatted{ - + terraref.ncsa.illinois.edu