Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EMLeditor documentation updates #164

Merged
merged 9 commits into from
Oct 23, 2024
Merged

EMLeditor documentation updates #164

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c8e8990
updates to function description and parameter text
Oct 9, 2024
6d15290
Update restricted language
Oct 9, 2024
c16223f
adjusted CC0 to mirror public and restricted
Oct 9, 2024
b8945ac
Fix misspelling
Oct 9, 2024
5a15a29
ORCID text updates
Oct 9, 2024
2ab5201
Updated set CUI code description
Oct 10, 2024
080c9c7
updated set_cui description
Oct 10, 2024
6f7c5ec
devtools::document()
Oct 23, 2024
1790075
pkgdown::build_site_github_pages()
Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions R/editEMLfunctions.R
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the text here will require updating the text that DPchecker is looking for; I'll make those changes today to keep everything in sync.

Original file line number Diff line number Diff line change
Expand Up @@ -2014,15 +2014,15 @@ set_publisher <- function(eml_object,
return(eml_object)
}

#' Set Intellectual Rights (and license name)
#' Set Intellectual Rights (and License)
#'
#' @description set_int_rights allows the intellectualRights field in EML to be surgically replaced.
#' @description set_int_rights allows the intellectualRights and licenseName fields in EML to be surgically replaced.
#'
#' @details set_int_rights requires that CUI information be listed in additionalMetadata prior to being called. The verbose `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 `set_cui_code()`) is appropriate for the license type chosen. For must public NPS dataset, the CC0 license is appropriate.
#' @details set_int_rights requires that CUI information be listed in additionalMetadata prior to being called. The verbose `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 `set_cui_code()`) is appropriate for the license type chosen. For most public NPS datasets, the CC0 license is appropriate.

#' @inheritParams set_title
#'
#' @param 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 `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
#' @param license String. Indicates the type of license to be used. The three potential options are "CC0", "public" and "restricted". CC0 and public can only be used if CUI is set to PUBLIC. Restricted can only be used if CUI is set to any code that is NOT set to PUBLIC (see `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
#'
#' @importFrom stats complete.cases
#'
Expand All @@ -2045,7 +2045,7 @@ set_int_rights <- function(eml_object,
#set up license text:
CCzero <- 'This product is released to the "public domain" under Creative Commons CC0 1.0 No Rights Reserved (see: https://creativecommons.org/publicdomain/zero/1.0/).'
pub_domain <- 'This product is released to the "public domain" under U.S. Government Works No Rights Reserved (see: http://www.usa.gov/publicdomain/label/1.0/).'
restrict <- "This product has been determined to contain Controlled Unclassified Information (CUI) by the National Park Service, and is intended for internal use only. It is not published under an open license. Unauthorized access, use, and distribution are prohibited."
restrict <- "This product has been determined to contain Controlled Unclassified Information (CUI) or to be otherwise restricted by the National Park Service, and is intended for specific purposes. It is not published under an open license. Unauthorized access, use, and distribution are prohibited."

# get CUI info from additionalMetadata:
cui <- eml_object$additionalMetadata
Expand Down