From 8cc0cb2d72d3f6b063dab0ed6197bc1184b7a1ea Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Tue, 9 Jul 2024 09:13:22 -0600 Subject: [PATCH] updates via pkgdown and devtools::document --- NAMESPACE | 1 + docs/news/index.html | 1 + docs/pkgdown.yml | 2 +- docs/reference/get_user_email.html | 117 +++++++++++++++++++++++++++++ docs/reference/index.html | 4 + docs/sitemap.xml | 3 + man/get_user_email.Rd | 24 ++++++ 7 files changed, 151 insertions(+), 1 deletion(-) create mode 100644 docs/reference/get_user_email.html create mode 100644 man/get_user_email.Rd diff --git a/NAMESPACE b/NAMESPACE index dfcd2b6..f63564d 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -17,6 +17,7 @@ export(get_dp_flags) export(get_elevation) export(get_park_polygon) export(get_taxon_rank) +export(get_user_email) export(get_utm_zone) export(long2UTM) export(order_cols) diff --git a/docs/news/index.html b/docs/news/index.html index 836f289..fd274e8 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -65,6 +65,7 @@

Changelog

QCkit v0.1.8 (not yet released)

+

2024-07-09 * Added function get_user_email(), which accesses NPS active directory via a powershell function to return the user’s email address. Probably won’t work for non-NPS users and probably won’t work for non-windows users. * Updated rest API from legacy v6 to current v7.

2024-06-28 * Updated get_park_polygon() to use the new API (had been using a legacy API). Added documentation to specify that the function is getting the convexhull for the park, which may not work particularly well for some parks. 2024-06-27 * bug fixes for generate_ll_from_utm() * add function remove_empty_tables() (and associated unit tests) * update documentation for replace blanks() to indicate it can replace blanks with more than just NA

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index c6ecf10..6e19b1b 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -5,5 +5,5 @@ articles: DRR_Purpose_and_Scope: DRR_Purpose_and_Scope.html Starting-a-DRR: Starting-a-DRR.html Using-the-DRR-Template: Using-the-DRR-Template.html -last_built: 2024-06-28T15:11Z +last_built: 2024-07-09T14:49Z diff --git a/docs/reference/get_user_email.html b/docs/reference/get_user_email.html new file mode 100644 index 0000000..b8bbd47 --- /dev/null +++ b/docs/reference/get_user_email.html @@ -0,0 +1,117 @@ + +Retrieves an NPS user's email address — get_user_email • QCkit + + +
+
+ + + +
+
+
+

Retrieves an NPS user's email address

+ Source: R/utils.R + +
+ +
+

Retrieves an NPS user's email address

+
+ +
+ 
get_user_email()
+
+ +
+

Value

+ + +

String. The user's email address.

+
+
+

Details

+

The function accesses the system username and then uses a powershell wrapper to access NPS active directory and supply information about the user. That information is then parsed down to the user's email address.

+

This function probaby won't work for anyone outside of NPS and likely won't work for anyone who is not using a Windows machine. So build those prerequisites (NPS = FALSE) in when calling it from within other function.

+
+ +
+

Examples

+ 
if (FALSE) {
+email <- get_user_email()
+}
+
+
+
+ +
+ + +
+

Developed by Robert Baker, Judd Patterson, Joe DeVivo, Issac Quevedo, Sarah Wright.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 47a6f20..268af56 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -122,6 +122,10 @@

All functions get_taxon_rank()

Taxonomic Rank Determination Function

+ +

get_user_email()

+ +

Retrieves an NPS user's email address

get_utm_zone()

diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 7247e4b..31e79b0 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -84,6 +84,9 @@ /reference/get_taxon_rank.html + + /reference/get_user_email.html + /reference/get_utm_zone.html diff --git a/man/get_user_email.Rd b/man/get_user_email.Rd new file mode 100644 index 0000000..6a1840f --- /dev/null +++ b/man/get_user_email.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/utils.R +\name{get_user_email} +\alias{get_user_email} +\title{Retrieves an NPS user's email address} +\usage{ +get_user_email() +} +\value{ +String. The user's email address. +} +\description{ +Retrieves an NPS user's email address +} +\details{ +The function accesses the system username and then uses a powershell wrapper to access NPS active directory and supply information about the user. That information is then parsed down to the user's email address. + +This function probaby won't work for anyone outside of NPS and likely won't work for anyone who is not using a Windows machine. So build those prerequisites (NPS = FALSE) in when calling it from within other function. +} +\examples{ +\dontrun{ +email <- get_user_email() +} +}