diff --git a/EMLeditor.Rproj b/EMLeditor.Rproj index 69fafd4..21473c3 100644 --- a/EMLeditor.Rproj +++ b/EMLeditor.Rproj @@ -1,4 +1,5 @@ Version: 1.0 +ProjectId: 25a099de-8eb3-4bb2-b366-f37bd0bee343 RestoreWorkspace: No SaveWorkspace: No diff --git a/NEWS.md b/NEWS.md index 8b58784..3c0f89e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,6 @@ # EMLeditor v0.1.7 (under development) +## 2025-01-16 + * Fix bug in `set_project` and update associated documentation. ## 2024-11-04 * Fix documentation in EMLscript code chunk that can make it difficult/confusing to enter user input after running the `upload_data_package` function. ## 2024-10-23 diff --git a/R/editEMLfunctions.R b/R/editEMLfunctions.R index fd2f7e6..25106ab 100644 --- a/R/editEMLfunctions.R +++ b/R/editEMLfunctions.R @@ -1499,9 +1499,9 @@ set_protocol <- function(eml_object, #' Adds a reference to a DataStore Project housing the data package #' #' @description -#' The function will add a single project title and URL to the metadata corresponding to the DataStore Project reference that the data package should be linked to. Upon EML extraction on DataStore, the data package will automatically be added/linked to the DataStore project indicated. +#' The function will add a single project title and URL to the metadata corresponding to the DataStore Project reference that the data package should be linked to. Upon EML extraction on DataStore, the data package will automatically be added/linked to the DataStore project indicated.EML2.2.0 only supports a single project so `set_project()`will overwrite/replace an existing project element. #' -#' @details This function will only add a project; it will not overwrite existing projects. To add a DataStore project to your metadata, the project must be publicly available. If you add multiple DataStore projects to metadata, only the first DataStore project will be used by DataStore. The person uploading and extracting the EML must be an owner on both the data package and project references in order to have the correct permissions for DataStore to create the desired link. If you have set NPS = TRUE and force = FALSE (the default settings), the function will also test whether you have owner-level permissions for the project which is necessary for DataStore to automatically connect your data package with the project. +#' @details This function will overwrite existing projects. To add a DataStore project to your metadata, the project must be publicly available. The person uploading and extracting the EML must be an owner on both the data package and project references in order to have the correct permissions for DataStore to create the desired link. If you have set NPS = TRUE and force = FALSE (the default settings), the function will also test whether you have owner-level permissions for the project which is necessary for DataStore to automatically connect your data package with the project. #' #' DataStore only add links between data packages and projects. DataStore cannot not remove data packages from projects. If need to remove a link between a data package and a project (perhaps you supplied the incorrect project reference ID at first), you will need to manually remove the connection using the DataStore web interface. #' @@ -1644,23 +1644,48 @@ set_project <- function(eml_object, ), id = "DataStore_project" ) + #whenever EML 3.0.0 comes out (or mutliple projects are allowd) this can + #be uncommented to allow set_project to add to existing projects + #rather than replace them: + #get existing projects: existing_projects <- eml_object$dataset$project if (is.null(existing_projects)) { eml_object$dataset$project <- proj - } else { - #if there are multiple projects: - if (length(seq_along(existing_projects[[1]])) > 1) { - # combine new and old projects (with new DataStore project at the top) - proj <- append(list(proj), existing_projects) - # overwrite the existing projects in EML with new project list: - eml_object$dataset$project <- proj + if (force == FALSE) { + msg1 <- paste0("The DataStore project {.var {project_reference_id}} with", + " the title {.var {project_title}} has been added to your", + " metadata.") + msg2 <- paste0("Your data package will be automatically linked to this ", + "project when once it is uploaded to DataStore and the ", + "metadata are extracted.") + cli::cli_inform(c("i" = msg1)) + cli::cli_inform(c("i" = msg2)) } - #if there is only one existing project: - if (length(seq_along(existing_projects[[1]])) == 1) { - proj <- append(list(proj), list(existing_projects)) - eml_object$dataset$project <- proj + } else { + if (!is.null(existing_projects)) { + cli::cli_alert_info("This metadata already contains a Project") + cli::cli_inform("Are you sure you want to replace the existing project?") + var1 <- .get_user_input() #1: Yes; 2: No\n" + if (var1 == 1) { + eml_object$dataset$project <- proj + if (force == FALSE) { + msg1 <- paste0("The DataStore project {.var {project_reference_id}} ", + "with the title {.var {project_title}} has been added ", + "to your metadata.") + msg2 <- paste0("Your data package will be automatically linked to ", + "this project when once it is uploaded to DataStore ", + "and the metadata are extracted.") + cli::cli_inform(c("i" = msg1)) + cli::cli_inform(c("i" = msg2)) + } + } + if (var1 == 2) { + if (force == FALSE) { + cli::cli_inform("Your original project was retained.") + } + } } } @@ -1671,16 +1696,7 @@ set_project <- function(eml_object, # add/update EMLeditor and version to metadata: eml_object <- .set_version(eml_object) - if (force == FALSE) { - msg1 <- paste0("The DataStore project {.var {project_reference_id}} with ", - "the title {.var {project_title}} has been added to your ", - "metadata.") - msg2 <- paste0("Your data package will be automatically linked to this ", - "project when once it is uploaded to DataStore and the ", - "metadata are extracted.") - cli::cli_inform(c("i" = msg1)) - cli::cli_inform(c("i" = msg2)) - } + return(eml_object) } @@ -2885,3 +2901,4 @@ set_missing_data <- function(eml_object, } + diff --git a/docs/authors.html b/docs/authors.html index d8073bb..6aae81a 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -95,14 +95,14 @@

Citation

-

Baker R, Patterson J (2024). +

Baker R, Patterson J (2025). EMLeditor: View and Edit EML Metadata. R package version 0.1.6, https://github.com/nationalparkservice/EMLeditor. 

@Manual{,
   title = {EMLeditor: View and Edit EML Metadata},
   author = {Robert Baker and Judd Patterson},
-  year = {2024},
+  year = {2025},
   note = {R package version 0.1.6},
   url = {https://github.com/nationalparkservice/EMLeditor},
 }
diff --git a/docs/news/index.html b/docs/news/index.html index 0e472f7..62f0646 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -72,8 +72,9 @@

Changelog

EMLeditor v0.1.7 (under development)

-

2024-11-04

-
-

The function will add a single project title and URL to the metadata corresponding to the DataStore Project reference that the data package should be linked to. Upon EML extraction on DataStore, the data package will automatically be added/linked to the DataStore project indicated.

+

The function will add a single project title and URL to the metadata corresponding to the DataStore Project reference that the data package should be linked to. Upon EML extraction on DataStore, the data package will automatically be added/linked to the DataStore project indicated.EML2.2.0 only supports a single project so set_project()will overwrite/replace an existing project element.

@@ -114,7 +114,7 @@

Value

Details

-

This function will only add a project; it will not overwrite existing projects. To add a DataStore project to your metadata, the project must be publicly available. If you add multiple DataStore projects to metadata, only the first DataStore project will be used by DataStore. The person uploading and extracting the EML must be an owner on both the data package and project references in order to have the correct permissions for DataStore to create the desired link. If you have set NPS = TRUE and force = FALSE (the default settings), the function will also test whether you have owner-level permissions for the project which is necessary for DataStore to automatically connect your data package with the project.

+

This function will overwrite existing projects. To add a DataStore project to your metadata, the project must be publicly available. The person uploading and extracting the EML must be an owner on both the data package and project references in order to have the correct permissions for DataStore to create the desired link. If you have set NPS = TRUE and force = FALSE (the default settings), the function will also test whether you have owner-level permissions for the project which is necessary for DataStore to automatically connect your data package with the project.

DataStore only add links between data packages and projects. DataStore cannot not remove data packages from projects. If need to remove a link between a data package and a project (perhaps you supplied the incorrect project reference ID at first), you will need to manually remove the connection using the DataStore web interface.

diff --git a/man/set_project.Rd b/man/set_project.Rd index fa0ff65..bbad27a 100644 --- a/man/set_project.Rd +++ b/man/set_project.Rd @@ -27,10 +27,10 @@ set_project( eml_object } \description{ -The function will add a single project title and URL to the metadata corresponding to the DataStore Project reference that the data package should be linked to. Upon EML extraction on DataStore, the data package will automatically be added/linked to the DataStore project indicated. +The function will add a single project title and URL to the metadata corresponding to the DataStore Project reference that the data package should be linked to. Upon EML extraction on DataStore, the data package will automatically be added/linked to the DataStore project indicated.EML2.2.0 only supports a single project so \code{set_project()}will overwrite/replace an existing project element. } \details{ -This function will only add a project; it will not overwrite existing projects. To add a DataStore project to your metadata, the project must be publicly available. If you add multiple DataStore projects to metadata, only the first DataStore project will be used by DataStore. The person uploading and extracting the EML must be an owner on both the data package and project references in order to have the correct permissions for DataStore to create the desired link. If you have set NPS = TRUE and force = FALSE (the default settings), the function will also test whether you have owner-level permissions for the project which is necessary for DataStore to automatically connect your data package with the project. +This function will overwrite existing projects. To add a DataStore project to your metadata, the project must be publicly available. The person uploading and extracting the EML must be an owner on both the data package and project references in order to have the correct permissions for DataStore to create the desired link. If you have set NPS = TRUE and force = FALSE (the default settings), the function will also test whether you have owner-level permissions for the project which is necessary for DataStore to automatically connect your data package with the project. DataStore only add links between data packages and projects. DataStore cannot not remove data packages from projects. If need to remove a link between a data package and a project (perhaps you supplied the incorrect project reference ID at first), you will need to manually remove the connection using the DataStore web interface. }