From 0e6d17b5d0f6f397307df5541e8e6112df5aca85 Mon Sep 17 00:00:00 2001 From: Laura DeCicco <ldecicco@usgs.gov> Date: Thu, 3 Jan 2013 14:21:36 -0600 Subject: [PATCH] Updating license to follow both CRAN and USGS standards. --- DESCRIPTION | 3 ++- LICENSE | 18 ++++++++++++++++++ R/getStoretData.r | 2 +- R/retrieveUnitNWISData.r | 1 - R/tabbedDataRetrievals.R | 5 +++-- man/dataRetrieval-package.Rd | 15 ++++++++------- man/getStoretData.Rd | 6 +----- man/retrieveUnitNWISData.Rd | 3 --- 8 files changed, 33 insertions(+), 20 deletions(-) create mode 100644 LICENSE diff --git a/DESCRIPTION b/DESCRIPTION index 789163d3..cca27b27 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,7 +7,8 @@ Author: Robert M. Hirsch, Laura De Cicco Maintainer: Laura De Cicco <ldecicco@usgs.gov> Description: Collection of functions to help retrieve USGS data from either web services or user provided data files. -License: This software is in the public domain because it contains materials +License: file LICENSE +Copyright: This software is in the public domain because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..73555598 --- /dev/null +++ b/LICENSE @@ -0,0 +1,18 @@ +U.S.Geological Survey Software User Rights Notice +Copied from http://water.usgs.gov/software/help/notice/ on September 7, 2012. Please check webpage for updates. + +Software and related material (data and (or) documentation), contained in or furnished in connection with a software distribution, are made available by the U.S. Geological Survey (USGS) to be used in the public interest and in the advancement of science. You may, without any fee or cost, use, copy, modify, or distribute this software, and any derivative works thereof, and its supporting documentation, subject to the following restrictions and understandings. + +If you distribute copies or modifications of the software and related material, make sure the recipients receive a copy of this notice and receive or can get a copy of the original distribution. If the software and (or) related material are modified and distributed, it must be made clear that the recipients do not have the original and they must be informed of the extent of the modifications. For example, modified files must include a prominent notice stating the modifications made, the author of the modifications, and the date the modifications were made. This restriction is necessary to guard against problems introduced in the software by others, reflecting negatively on the reputation of the USGS. + +The software is public property and you therefore have the right to the source code, if desired. + +You may charge fees for distribution, warranties, and services provided in connection with the software or derivative works thereof. The name USGS can be used in any advertising or publicity to endorse or promote any products or commercial entity using this software if specific written permission is obtained from the USGS. + +The user agrees to appropriately acknowledge the authors and the USGS in publications that result from the use of this software or in products that include this software in whole or in part. + +Because the software and related material are free (other than nominal materials and handling fees) and provided "as is," the authors, the USGS, and the United States Government have made no warranty, express or implied, as to accuracy or completeness and are not obligated to provide the user with any support, consulting, training or assistance of any kind with regard to the use, operation, and performance of this software nor to provide the user with any updates, revisions, new versions or "bug fixes". + +The user assumes all risk for any damages whatsoever resulting from loss of use, data, or profits arising in connection with the access, use, quality, or performance of this software. + +R and other package dependencies have more restrictive licenses. \ No newline at end of file diff --git a/R/getStoretData.r b/R/getStoretData.r index 263a4278..9d72bd8e 100644 --- a/R/getStoretData.r +++ b/R/getStoretData.r @@ -5,7 +5,7 @@ #' A list of statistic codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} #' #' @param siteNumber string USGS site number. This is usually an 8 digit number -#' @param ParameterCd string USGS parameter code. This is usually an 5 digit number. Multiple parameter codes can be inputted with a ';' separator. Leaving this blank will return all of the measured values during the specified time period. +#' @param characteristicName string #' @param StartDate string starting date for data retrieval in the form YYYY-MM-DD. #' @param EndDate string ending date for data retrieval in the form YYYY-MM-DD. #' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. diff --git a/R/retrieveUnitNWISData.r b/R/retrieveUnitNWISData.r index 6a708da4..7305cfd9 100644 --- a/R/retrieveUnitNWISData.r +++ b/R/retrieveUnitNWISData.r @@ -8,7 +8,6 @@ #' @param ParameterCd string USGS parameter code. This is usually an 5 digit number. #' @param StartDate string starting date for data retrieval in the form YYYY-MM-DD. #' @param EndDate string ending date for data retrieval in the form YYYY-MM-DD. -#' @param StatCd string USGS statistic code. This is usually 5 digits. Daily mean (00003) is the default. #' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. #' @keywords data import USGS web service #' @return retval dataframe with agency, site, dateTime, time zone, value, and code columns diff --git a/R/tabbedDataRetrievals.R b/R/tabbedDataRetrievals.R index 61cc7d14..e3e17927 100644 --- a/R/tabbedDataRetrievals.R +++ b/R/tabbedDataRetrievals.R @@ -3,9 +3,10 @@ #' \tabular{ll}{ #' Package: \tab dataRetrieval\cr #' Type: \tab Package\cr -#' Version: \tab 1.0.4\cr +#' Version: \tab 1.2.1\cr #' Date: \tab 2012-12-31\cr -#' License: \tab This software is in the public domain because it contains materials +#' License: \tab Unlimited for this package, dependencies have more restrictive licensing.\cr +#' Copyright: \tab This software is in the public domain because it contains materials #' that originally came from the United States Geological Survey, an agency of #' the United States Department of Interior. For more information, see the #' official USGS copyright policy at diff --git a/man/dataRetrieval-package.Rd b/man/dataRetrieval-package.Rd index 76f6c23e..055aa874 100644 --- a/man/dataRetrieval-package.Rd +++ b/man/dataRetrieval-package.Rd @@ -4,13 +4,14 @@ \title{Retrieval functions for USGS data} \description{ \tabular{ll}{ Package: \tab dataRetrieval\cr Type: \tab - Package\cr Version: \tab 1.0.4\cr Date: \tab - 2012-12-31\cr License: \tab This software is in the - public domain because it contains materials that - originally came from the United States Geological Survey, - an agency of the United States Department of Interior. - For more information, see the official USGS copyright - policy at + Package\cr Version: \tab 1.2.1\cr Date: \tab + 2012-12-31\cr License: \tab Unlimited for this package, + dependencies have more restrictive licensing.\cr + Copyright: \tab This software is in the public domain + because it contains materials that originally came from + the United States Geological Survey, an agency of the + United States Department of Interior. For more + information, see the official USGS copyright policy at http://www.usgs.gov/visual-id/credit_usgs.html#copyright\cr LazyLoad: \tab yes\cr } } diff --git a/man/getStoretData.Rd b/man/getStoretData.Rd index f261d80e..e3abde84 100644 --- a/man/getStoretData.Rd +++ b/man/getStoretData.Rd @@ -9,11 +9,7 @@ \item{siteNumber}{string USGS site number. This is usually an 8 digit number} - \item{ParameterCd}{string USGS parameter code. This is - usually an 5 digit number. Multiple parameter codes can - be inputted with a ';' separator. Leaving this blank - will return all of the measured values during the - specified time period.} + \item{characteristicName}{string} \item{StartDate}{string starting date for data retrieval in the form YYYY-MM-DD.} diff --git a/man/retrieveUnitNWISData.Rd b/man/retrieveUnitNWISData.Rd index 79001197..fa6f1488 100644 --- a/man/retrieveUnitNWISData.Rd +++ b/man/retrieveUnitNWISData.Rd @@ -18,9 +18,6 @@ \item{EndDate}{string ending date for data retrieval in the form YYYY-MM-DD.} - \item{StatCd}{string USGS statistic code. This is usually - 5 digits. Daily mean (00003) is the default.} - \item{interactive}{logical Option for interactive mode. If true, there is user interaction for error handling and data checks.} -- GitLab