Merge pull request #168 from CVPIA-OSC/funding-element

Funding element
CVPIA-OSC · Aug 7, 2023 · bb1973d · bb1973d
2 parents 26fdca0 + e3def62
commit bb1973d
Show file tree

Hide file tree

Showing 71 changed files with 248 additions and 117 deletions.
diff --git a/R/funding-element.R b/R/funding-element.R
@@ -13,29 +13,25 @@
 #' @param award_number (Optional) The identifier assigned by the funding agency to identify this funding award.
 #' @param award_url (Optional) Optional to include a link to information about the funding
 #'  award on the funding organization's webpage.
-#' @param funding_description (Optional) Provide a short description of the funding received.
 #' @return An award list that is then added to the project element of an EML file.  
 #' @examples 
 #' create_funding(funder_name = "National Science Foundation",
 #'                funder_identifier = "http://dx.doi.org/10.13039/100000001",
 #'                award_number = "1656026",
 #'                award_title = "National Science Foundation Grant",
-#'                award_url = "https://www.nsf.gov/awardsearch/showAward?AWD_ID=1656026",
-#'                funding_description = "BLE LTER is supported by the National Science 
-#'                                      Foundation under award #1656026 
-#'                                       (2017-08-01 to 2022-07-31)." )
+#'                award_url = "https://www.nsf.gov/awardsearch/showAward?AWD_ID=1656026")
 #' @export
 
 create_funding <- function(funder_name, award_title, funder_identifier = NULL, 
-                        award_number = NULL, award_url = NULL, funding_description = NULL)  {
+                        award_number = NULL, award_url = NULL)  {
 
   award <- list()
   required_arguments <- c("funder_name", "award_title", "funder_identifier", 
-                          "award_number", "award_url", "funding_description")
+                          "award_number", "award_url")
 
   missing_argument_index <- which(c(missing(funder_name), missing(award_title), 
                                     missing(funder_identifier), missing(award_number),  
-                                    missing(award_url), missing(funding_description)))
+                                    missing(award_url)))
 
   if (length(missing_argument_index) > 0) {
     fund_error <- required_arguments[missing_argument_index][1]
@@ -66,7 +62,7 @@ create_funding <- function(funder_name, award_title, funder_identifier = NULL,
     award <- list(funderName = funder_name,
                   title = award_title)
     if (missing(award_url) | missing(award_number) | 
-        missing(funder_identifier) | missing(funding_description)) {
+        missing(funder_identifier)) {
       warning(fund_error_message, call. = FALSE)
     }
   }
@@ -78,9 +74,6 @@ create_funding <- function(funder_name, award_title, funder_identifier = NULL,
   if (!is.null(award_number)) {
     award$awardNumber = award_number 
   }
-  if (!is.null(funding_description)) {
-    award$description = funding_description 
-  }
   if (!is.null(award_url)) {
     award$awardUrl <- award_url
   }

diff --git a/R/project-element.R b/R/project-element.R
@@ -12,7 +12,7 @@
 #'                                    role = "creator", organization = "USBR")
 #' funding_metadata <- list(funder_name = "USBR", funder_identifier = NA, award_number = "R14AC00096", 
 #'                          award_title = "Salmonid Spawning and Rearing Habitat Restoration in the Sacramento River", 
-#'                          award_url = NA, funding_description = NA)
+#'                          award_url = NA)
 #' 
 #' create_project(project_title, project_lead, funding_metadata)
 #' @export                                                                          
@@ -47,7 +47,7 @@ create_project <- function(project_title, project_lead, funding_metadata) {
 #'                               role = "creator", organization = "USBR", orcid = NA)
 #' funding_metadata <- list(funder_name = "USBR", funder_identifier = NA, award_number = "R14AC00096", 
 #'                          award_title = "Salmonid Spawning and Rearing Habitat Restoration in the Sacramento River", 
-#'                          award_url = NA, funding_description = NA)
+#'                          award_url = NA)
 #' 
 #' dataset <- list() %>%
 #'    add_title(list(title = "O.mykiss Habitat monitoring and contact point project", short_name = "O.mykiss monitoring")) %>%

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/create-EML-from-template.html b/docs/articles/create-EML-from-template.html
diff --git a/docs/articles/template-doc.html b/docs/articles/template-doc.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -1,10 +1,11 @@
-pandoc: 2.19.2
+pandoc: 3.1.1
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles:
   create-EML-from-template: create-EML-from-template.html
   template-doc: template-doc.html
-last_built: 2023-04-03T20:23Z
+  update-data-package: update-data-package.html
+last_built: 2023-08-01T16:46Z
 urls:
   reference: https://CVPIA-OSC.github.io/EMLaide/reference
   article: https://CVPIA-OSC.github.io/EMLaide/articles

diff --git a/docs/reference/CVPIA_common_species.html b/docs/reference/CVPIA_common_species.html
diff --git a/docs/reference/CVPIA_funders.html b/docs/reference/CVPIA_funders.html
diff --git a/docs/reference/add_abstract.html b/docs/reference/add_abstract.html
diff --git a/docs/reference/add_access.html b/docs/reference/add_access.html
diff --git a/docs/reference/add_coverage.html b/docs/reference/add_coverage.html
diff --git a/docs/reference/add_datatable.html b/docs/reference/add_datatable.html
diff --git a/docs/reference/add_keyword_set.html b/docs/reference/add_keyword_set.html
diff --git a/docs/reference/add_license.html b/docs/reference/add_license.html
diff --git a/docs/reference/add_maintenance.html b/docs/reference/add_maintenance.html
diff --git a/docs/reference/add_method.html b/docs/reference/add_method.html
diff --git a/docs/reference/add_other_entity.html b/docs/reference/add_other_entity.html
diff --git a/docs/reference/add_personnel.html b/docs/reference/add_personnel.html