R/submit_archive.R

In galaxias: Describe, Package, and Share Biodiversity Data

#' Submit a Darwin Core Archive to the ALA
#' 
#' The preferred method for submitting a dataset for publication via the ALA
#' is to raise an issue on our ['Data Publication' GitHub Repository](https://github.com/AtlasOfLivingAustralia/data-publication),
#' and attached your archive zip file (constructed using [build_archive()]) to 
#' that issue. If your dataset is especially large (>100MB), you will need to 
#' post it in a publicly accessible location (such as a GitHub release) and post 
#' the link instead. This function simply opens a new issue in the users' 
#' default browser to enable dataset submission.
#' @param quiet Whether to suppress messages about what is happening. 
#' Default is set to `FALSE`; i.e. messages are shown.
#' @details
#' The process for accepting data for publication at ALA is not automated;
#' this function will initiate an evaluation process, and will not result in 
#' your data being instantly visible on the ALA. Nor does submission guarantee 
#' acceptance, as ALA reserves the right to refuse to publish data that reveals 
#' the locations of threatened or at-risk species.
#' 
#' This mechanism is **entirely public**; your data will be visible to others
#' from the point you put it on this webpage. If your data contains sensitive
#' information, contact [support@ala.org.au](mailto:support@ala.org.au) to 
#' arrange a different delivery mechanism.
#' @returns Does not return anything to the workspace; called for the side-effect
#' of opening a submission form in the users' default browser.
#' @examples
#' if(interactive()){
#'   submit_archive()
#' }
#' @export
submit_archive <- function(quiet = FALSE){
  if(quiet){
    launch_browser()
  }else if(rlang::is_interactive()){ 
    
    choice <- cli_menu(
      c(" ",
        "Running this function will open a data submission page in your default browser.", 
        "There you will be prompted to upload a Darwin Core Archive.", 
        " "),
      "Do you want to proceed? (0 to exit)",
      choices = c("Yes", "No")
    )
    
    if (choice == 1) {
      launch_browser()
    } else {
      cli::cli_inform(c(
        i = "Exiting..."
      ))
      # exits process quietly
      invokeRestart("abort")
    }
  } 
}


#' simple internal function to launch GH issue with correct template
#' @noRd
#' @keywords Internal
launch_browser <- function(){
  url <- "https://github.com/AtlasOfLivingAustralia/data-publication/issues/new?template=new-dataset.md"
  utils::browseURL(url)
}