Trying the examplesIf

.github/workflows/pkgdown.yaml

@@ -44,7 +44,6 @@ jobs:
   
       - name: Deploy package
         run: |
-          Sys.setenv(CI = FALSE)
           options(rmarkdown.html_vignette.check_title = FALSE)
           pkgdown::deploy_to_branch(new_process = FALSE)
         shell: Rscript {0}

DESCRIPTION

@@ -55,4 +55,4 @@ BuildVignettes: true
 VignetteBuilder: knitr
 BugReports: https://github.com/USGS-R/dataRetrieval/issues
 URL: https://pubs.usgs.gov/tm/04/a10/
-RoxygenNote: 7.1.1
+RoxygenNote: 7.1.2

NAMESPACE

@@ -16,6 +16,7 @@ export(importRDB1)
 export(importWQP)
 export(importWaterML1)
 export(importWaterML2)
+export(is_dataRetrieval_user)
 export(pCodeToName)
 export(parameterCdFile)
 export(readNGWMNdata)

R/AAA.R

@@ -5,3 +5,14 @@ pkg.env <- new.env()
     pkg.env$nldi_base <- "https://labs.waterdata.usgs.gov/api/nldi/linked-data/"
     pkg.env$local_sf <- requireNamespace("sf", quietly = TRUE)
 }
+
+
+#' Is this a dataRetrieval user
+#' 
+#' Reveals if this is a user or not
+#' @export
+#' @examples 
+#' is_dataRetrieval_user()
+is_dataRetrieval_user <- function(){
+  interactive() | !!identical(Sys.getenv("CI"), "")
+}

R/findNLDI.R

@@ -225,7 +225,7 @@ valid_ask = function(all, type) {
 #' @return a list of data.frames if sf is not installed, a list of sf objects if it is
 #' @export
 #' @keywords nldi
-#' @examples
+#' @examplesIf is_dataRetrieval_user()
 #' \donttest{
 #' # Find Features / Define origin features
 #'

R/getWebServiceData.R

@@ -10,7 +10,7 @@
 #' @importFrom xml2 read_xml
 #' @export
 #' @return raw data from web services
-#' @examples
+#' @examplesIf is_dataRetrieval_user()
 #' siteNumber <- "02177000"
 #' startDate <- "2012-09-01"
 #' endDate <- "2012-10-01"

R/importRDB1.r

@@ -42,7 +42,7 @@
 #' comment \tab character \tab Header comments from the RDB file \cr
 #' }
 #' @export
-#' @examples
+#' @examplesIf is_dataRetrieval_user()
 #' site_id <- "02177000"
 #' startDate <- "2012-09-01"
 #' endDate <- "2012-10-01"

R/importWQP.R

@@ -15,7 +15,7 @@
 #' start and end times, and converted to UTC. See \url{https://www.waterqualitydata.us/portal_userguide/} for more information.
 #' @export
 #' @seealso \code{\link{readWQPdata}}, \code{\link{readWQPqw}}, \code{\link{whatWQPsites}}
-#' @examples
+#' @examplesIf is_dataRetrieval_user()
 #' # These examples require an internet connection to run
 #' 
 #' ## Examples take longer than 5 seconds:

R/importWaterML1.r

@@ -47,7 +47,7 @@
 #' @importFrom xml2 xml_attrs
 #' @importFrom xml2 xml_attr
 #' @importFrom xml2 xml_root
-#' @examples
+#' @examplesIf is_dataRetrieval_user()
 #' site_id <- "02177000"
 #' startDate <- "2012-09-01"
 #' endDate <- "2012-10-01"

R/readNGWMNdata.R

@@ -12,7 +12,7 @@
 #' "America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla". See also  \code{OlsonNames()} 
 #' for more information on time zones.
 #' @export
-#' @examples 
+#' @examplesIf is_dataRetrieval_user()
 #' \donttest{
 #' #one site
 #' site <- "USGS.430427089284901"

R/whatWQPdata.R

@@ -126,7 +126,7 @@ whatWQPmetrics <- function(...){
 #' 
 #' @export
 #' @seealso whatNWISsites
-#' @examples
+#' @examplesIf is_dataRetrieval_user()
 #' \donttest{
 #' site1 <- whatWQPdata(siteid="USGS-01594440")
 #' 

README.md

 # dataRetrieval <img src="man/figures/logo.png" alt="dataRetrieval" height="150px" align="right" />
  
-[![R build status](https://github.com/USGS-R/dataRetrieval/workflows/R-CMD-check/badge.svg)](https://github.com/USGS-R/dataRetrieval/actions)[![Coverage Status](https://coveralls.io/repos/github/USGS-R/dataRetrieval/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/dataRetrieval?branch=master) [![status](https://img.shields.io/badge/USGS-Core-green.svg)](https://owi.usgs.gov/R/packages.html#core) [![CRAN version](http://www.r-pkg.org/badges/version/dataRetrieval)](https://cran.r-project.org/package=dataRetrieval) [![](http://cranlogs.r-pkg.org/badges/dataRetrieval)](https://cran.r-project.org/package=dataRetrieval) [![](http://cranlogs.r-pkg.org/badges/grand-total/dataRetrieval)](https://cran.r-project.org/package=dataRetrieval)
-
 Retrieval functions for USGS and EPA hydrologic and water quality data.
 
 For complete tutorial information, see:

_pkgdown.yml

@@ -18,8 +18,6 @@ navbar:
       href: articles/movingAverages.html
     - text: Stat Service
       href: articles/statsServiceMap.html
-    - text: Earthquake Exploration
-      href: articles/earthquake.html
     - text: NLDI Interface
       href: articles/nldi.html
   right:
@@ -63,6 +61,15 @@ reference:
     desc: Functions to interface with the NLDI.
     contents:
       - findNLDI
+      - get_nldi_sources
+  - title: Import data
+    desc: Functions to import different data formats
+    contents:
+      - importRDB1
+      - importNGWMN
+      - importWaterML1
+      - importWaterML2
+      - importWQP
   - title: Helper functions
     contents:
       - calcWaterYear
@@ -71,4 +78,16 @@ reference:
       - setAccess
       - countyCdLookup
       - stateCdLookup
+      - countyCd
+      - parameterCdFile
+      - stateCd
       - zeroPad
+      - dataRetrieval
+  - title: Web query utilities
+    desc: Functions to create web queries
+    contents:
+      - constructNWISURL
+      - constructUseURL
+      - constructWQPURL
+      - getQuerySummary
+      - getWebServiceData

man/findNLDI.Rd

@@ -65,6 +65,7 @@ navigated paths. Valid starting options can be given by one of the following
 arguments: comid, nwis, huc12, wqp, location, and start.
 }
 \examples{
+\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 \donttest{
 # Find Features / Define origin features
 
@@ -106,5 +107,6 @@ arguments: comid, nwis, huc12, wqp, location, and start.
 ## Limit search to 50 km
  findNLDI(comid = 101, nav = "DM", find = c("nwis", "wqp", "flowlines"), distance_km = 50)
 }
+\dontshow{\}) # examplesIf}
 }
 \keyword{nldi}

man/getWebServiceData.Rd

@@ -19,6 +19,7 @@ This function accepts a url parameter, and returns the raw data. The function en
 \code{\link[httr]{GET}} with more informative error messages.
 }
 \examples{
+\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 siteNumber <- "02177000"
 startDate <- "2012-09-01"
 endDate <- "2012-10-01"
@@ -28,4 +29,5 @@ obs_url <- constructNWISURL(siteNumber,property,startDate,endDate,'dv')
 \donttest{
   rawData <- getWebServiceData(obs_url)
 }
+\dontshow{\}) # examplesIf}
 }

man/importRDB1.Rd

@@ -55,6 +55,7 @@ NWIS site, parameter code, statistic, startdate and enddate. It is not
 recommended to use the RDB format for importing multi-site data.
 }
 \examples{
+\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 site_id <- "02177000"
 startDate <- "2012-09-01"
 endDate <- "2012-10-01"
@@ -97,5 +98,5 @@ filePath <- system.file("extdata", package="dataRetrieval")
 fileName <- "RDB1Example.txt"
 fullPath <- file.path(filePath, fileName)
 importUserRDB <- importRDB1(fullPath)
-
+\dontshow{\}) # examplesIf}
 }

man/importWQP.Rd

@@ -26,6 +26,7 @@ start and end times, and converted to UTC. See \url{https://www.waterqualitydata
 Imports data from the Water Quality Portal based on a specified url.
 }
 \examples{
+\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 # These examples require an internet connection to run
 
 ## Examples take longer than 5 seconds:
@@ -42,7 +43,7 @@ STORETex <- constructWQPURL('WIDNR_WQX-10032762','Specific conductance', '', '')
 
  STORETdata <- importWQP(STORETex)
 }
-
+\dontshow{\}) # examplesIf}
 }
 \seealso{
 \code{\link{readWQPdata}}, \code{\link{readWQPqw}}, \code{\link{whatWQPsites}}

man/importWaterML1.Rd

@@ -50,6 +50,7 @@ This function accepts a url parameter that already contains the desired
 NWIS site, parameter code, statistic, startdate and enddate.
 }
 \examples{
+\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 site_id <- "02177000"
 startDate <- "2012-09-01"
 endDate <- "2012-10-01"
@@ -103,7 +104,7 @@ filePath <- system.file("extdata", package="dataRetrieval")
 fileName <- "WaterML1Example.xml"
 fullPath <- file.path(filePath, fileName)
 importFile <- importWaterML1(fullPath,TRUE)
-
+\dontshow{\}) # examplesIf}
 }
 \seealso{
 \code{\link{renameNWISColumns}}

man/is_dataRetrieval_user.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/AAA.R
+\name{is_dataRetrieval_user}
+\alias{is_dataRetrieval_user}
+\title{Is this a dataRetrieval user}
+\usage{
+is_dataRetrieval_user()
+}
+\description{
+Reveals if this is a user or not
+}
+\examples{
+is_dataRetrieval_user()
+}

man/readNGWMNdata.Rd

@@ -25,6 +25,7 @@ for more information on time zones.}
 Only water level data and site locations and names are currently available through the web service.
 }
 \examples{
+\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 \donttest{
 #one site
 site <- "USGS.430427089284901"
@@ -52,5 +53,5 @@ noDataSite <- "UTGS.401544112060301"
 #bboxData <- readNGWMNdata(service = "observation", siteNumbers = bboxSites$site[1:3], 
 #asDateTime = FALSE)
 }
-
+\dontshow{\}) # examplesIf}
 }