From b2cae700669e26cbfd8361bd026553fdf77d5fd9 Mon Sep 17 00:00:00 2001
From: Rob Baker <robert_baker@nps.gov>
Date: Thu, 29 Aug 2024 17:08:38 -0600
Subject: [PATCH] updated via devtools::document and
pkgdown::build_site_github_pages
---
docs/pkgdown.yml | 2 +-
docs/reference/set_int_rights.html | 4 ++--
man/set_int_rights.Rd | 4 ++--
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 849e880..62268f9 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -7,4 +7,4 @@ articles:
a03_Template_edits: a03_Template_edits.html
a04_Editing_fixing_eml: a04_Editing_fixing_eml.html
a05_advanced_functionality: a05_advanced_functionality.html
-last_built: 2024-08-29T22:52Z
+last_built: 2024-08-29T22:56Z
diff --git a/docs/reference/set_int_rights.html b/docs/reference/set_int_rights.html
index 3146eb2..eb93347 100644
--- a/docs/reference/set_int_rights.html
+++ b/docs/reference/set_int_rights.html
@@ -92,7 +92,7 @@ <h2>Arguments</h2>
<dt id="arg-license">license<a class="anchor" aria-label="anchor" href="#arg-license"></a></dt>
-<dd><p>String. Indicates the type of license to be used. The three potential options are "CC0" (CC zero), "public" and "restricted". CC0 and public can only be used if CUI is set to either PUBFUL or PUBVER. Restricted can only be used if CUI is set to any code that is NOT PUBFUL or PUBVER (see <code><a href="set_cui.html">set_cui()</a></code> for a list of codes). To view the exact text that will be inserted for each license, please see https://nationalparkservice.github.io/NPS_EML_Script/stepbystep.html#intellectual-rights</p></dd>
+<dd><p>String. Indicates the type of license to be used. The three potential options are "CC0" (CC zero), "public" and "restricted". CC0 and public can only be used if CUI is set to either PUBLIC. Restricted can only be used if CUI is set to any code that is NOT set to PUBLIC (see <code><a href="set_cui_code.html">set_cui_code()</a></code> for a list of codes). To view the exact text that will be inserted for each license, please see https://nationalparkservice.github.io/NPS_EML_Script/stepbystep.html#intellectual-rights</p></dd>
<dt id="arg-force">force<a class="anchor" aria-label="anchor" href="#arg-force"></a></dt>
@@ -109,7 +109,7 @@ <h2>Value</h2>
</div>
<div id="details">
<h2>Details</h2>
- <p>set_int_rights requires that CUI information be listed in additionalMetadata prior to being called. The verbose <code>force = FALSE</code> option will warn the user if there is no CUI specified. set_int_rights checks to make sure the CUI code specified (see <code><a href="set_cui.html">set_cui()</a></code>) is appropriate for the license type chosen.</p>
+ <p>set_int_rights requires that CUI information be listed in additionalMetadata prior to being called. The verbose <code>force = FALSE</code> option will warn the user if there is no CUI specified. <code>set_int_rights</code> checks to make sure the CUI code specified (see <code><a href="set_cui_code.html">set_cui_code()</a></code>) is appropriate for the license type chosen. For must public NPS dataset, the CC0 license is appropriate.</p>
</div>
<div id="ref-examples">
diff --git a/man/set_int_rights.Rd b/man/set_int_rights.Rd
index 7c97276..51172b3 100644
--- a/man/set_int_rights.Rd
+++ b/man/set_int_rights.Rd
@@ -14,7 +14,7 @@ set_int_rights(
\arguments{
\item{eml_object}{is an EML-formatted R object, either generated in R or imported (typically from an EML-formatted .xml file) using EML::read_eml(\if{html}{\out{<filename>}}, from="xml").}
-\item{license}{String. Indicates the type of license to be used. The three potential options are "CC0" (CC zero), "public" and "restricted". CC0 and public can only be used if CUI is set to either PUBFUL or PUBVER. Restricted can only be used if CUI is set to any code that is NOT PUBFUL or PUBVER (see \code{set_cui()} for a list of codes). To view the exact text that will be inserted for each license, please see https://nationalparkservice.github.io/NPS_EML_Script/stepbystep.html#intellectual-rights}
+\item{license}{String. Indicates the type of license to be used. The three potential options are "CC0" (CC zero), "public" and "restricted". CC0 and public can only be used if CUI is set to either PUBLIC. Restricted can only be used if CUI is set to any code that is NOT set to PUBLIC (see \code{set_cui_code()} for a list of codes). To view the exact text that will be inserted for each license, please see https://nationalparkservice.github.io/NPS_EML_Script/stepbystep.html#intellectual-rights}
\item{force}{logical. Defaults to false. If set to FALSE, a more interactive version of the function requesting user input and feedback. Setting force = TRUE facilitates scripting.}
@@ -27,7 +27,7 @@ eml_object
set_int_rights allows the intellectualRights field in EML to be surgically replaced.
}
\details{
-set_int_rights requires that CUI information be listed in additionalMetadata prior to being called. The verbose \code{force = FALSE} option will warn the user if there is no CUI specified. set_int_rights checks to make sure the CUI code specified (see \code{set_cui()}) is appropriate for the license type chosen.
+set_int_rights requires that CUI information be listed in additionalMetadata prior to being called. The verbose \code{force = FALSE} option will warn the user if there is no CUI specified. \code{set_int_rights} checks to make sure the CUI code specified (see \code{set_cui_code()}) is appropriate for the license type chosen. For must public NPS dataset, the CC0 license is appropriate.
}
\examples{
\dontrun{