add suggest_workflow() and use_metadata()

Former re-exported from `corella`; latter moved from `paperbark`. Also add `corella` as a Depends to ensure it always loads with galaxias

Author: mjwestgate

DESCRIPTION

@@ -21,10 +21,10 @@ Description: galaxias helps users describe, package and share biodiversity
   partner nodes. It is functionally similar to `devtools`, but with a focus on
   building Darwin Core Archives (DwCA's) rather than R packages.
 Depends: 
-  R (>= 4.3.0)
+  R (>= 4.3.0),
+  corella
 Imports:
   cli,
-  corella,
   curl,
   dplyr,
   glue,

NAMESPACE

@@ -11,6 +11,8 @@ export(galaxias_config)
 export(galaxias_package)
 export(galaxias_project)
 export(get_validator_report)
+export(suggest_workflow)
+export(use_metadata)
 export(validate_archive)
 importFrom(cli,cat_line)
 importFrom(cli,cli_abort)
@@ -20,6 +22,7 @@ importFrom(cli,cli_inform)
 importFrom(cli,cli_progress_step)
 importFrom(cli,cli_progress_update)
 importFrom(corella,check_dataset)
+importFrom(corella,suggest_workflow)
 importFrom(curl,form_data)
 importFrom(curl,form_file)
 importFrom(dplyr,bind_rows)
@@ -40,8 +43,8 @@ importFrom(jsonlite,toJSON)
 importFrom(jsonlite,unbox)
 importFrom(paperbark,check_eml)
 importFrom(paperbark,read_md)
-importFrom(paperbark,use_metadata)
 importFrom(paperbark,write_eml)
+importFrom(paperbark,write_md)
 importFrom(potions,brew)
 importFrom(potions,pour)
 importFrom(purrr,map)

R/check_archive.R

@@ -12,7 +12,7 @@
 #' the console.
 #' @importFrom utils unzip
 #' @export
-check_archive <- function(x = "data"){
+check_archive <- function(x = "data"){ # add `file` arg for consistency with `check_eml()`
   if(!file.exists(x)){
     abort(glue("file or directory '{x}' not found"))
   }else{
@@ -38,8 +38,8 @@ check_files <- function(filenames){
         switch(a, 
                "occurrences.csv" = {read_csv(a) |>
                                     check_dataset()},
-               "meta.xml" = {check_eml(a)},
-               "eml.xml" = {check_eml(a)}
+               "meta.xml" = {check_eml(file = a)},
+               "eml.xml" = {check_eml(file = a)}
        )
   }) |>
     invisible()

R/galaxias-package.R

@@ -3,7 +3,7 @@
 #' @description
 #' `galaxias` helps users describe, package and share biodiversity 
 #' information using the 'Darwin Core' data standard, which is the format used
-#' and accepted by the Global Biodiversity Information Facility (GBIF) and it's
+#' and accepted by the Global Biodiversity Information Facility (GBIF) and its'
 #' partner nodes. It is functionally similar to `devtools`, but with a focus on
 #' building Darwin Core Archives rather than R packages.
 #' 
@@ -16,10 +16,12 @@
 #' 
 #' **Set up a project**
 #'   * [galaxias_project()] Set up a project with the necessary folder structure
+#'   * [use_metadata()] Add a blank metadata statement to the working directory
+#'   * [suggest_workflow()] Advise on configuring a tibble for the Darwin Core standard
 #'
 #'  **Construct an archive**
 #'   * [build_schema()] Build a schema file (`meta.xml`) for a given directory
-#'   * [build_metadata()] Supply a metadata file in .md format, and convert to a metadata file (`eml.xml`)
+#'   * [build_metadata()] Convert a metadata file from markdown to EML (`eml.xml`)
 #'   * [build_archive()] Convert a directory to a Darwin Core Archive
 #'   
 #'  **Validate an archive**

R/galaxias_project.R

@@ -12,7 +12,6 @@
 #' side-effect of building a new project or package.
 #' @name galaxias_project
 #' @order 1
-#' @importFrom paperbark use_metadata
 #' @importFrom usethis create_project
 #' @importFrom usethis use_directory
 #' @export
@@ -21,7 +20,6 @@ galaxias_project <- function(path, ...){
   use_metadata()
   use_directory("data_raw")
   use_directory("data")
-  
 }
 
 #' @rdname galaxias_project

R/suggest_workflow.R

@@ -0,0 +1,3 @@
+#' @importFrom corella suggest_workflow
+#' @export
+corella::suggest_workflow

R/use_metadata.R

@@ -0,0 +1,30 @@
+#' Write an example metadata statement
+#' 
+#' This function takes `metadata_example` and exports it to the specified file.
+#' This is useful for creating a boilerplate metadata statement that you
+#' can edit yourself.
+#' @param file (string) A filename to save the statement to. Defaults to 
+#' `"metadata.md"`.
+#' @param overwrite (logical) Should any existing file with this name be 
+#' overwritten? Defaults to `FALSE`.
+#' @returns Does not return an object to the workspace; called for the 
+#' side-effect of saving a markdown file to the specified location.
+#' @importFrom glue glue
+#' @importFrom paperbark write_md
+#' @importFrom rlang abort
+#' @export
+use_metadata <- function(file, overwrite = FALSE){
+  if(missing(file)){
+    file <- "metadata.md"
+  }
+  if(overwrite){
+    write_md(paperbark::metadata_example, file = file)
+  }else{
+    if(file.exists(file)){
+      abort(c(glue("file `{file}` already exists."),
+              i = "give a different `file` or set `overwrite = TRUE`"))
+    }else{
+      write_md(paperbark::metadata_example, file = file)
+    }
+  }
+}

_pkgdown.yml

@@ -32,7 +32,10 @@ navbar:
       href: news/index.html
 reference:
 - title: Set up a project
-  contents: galaxias_project
+  contents: 
+  - galaxias_project
+  - use_metadata
+  - suggest_workflow
 - title: Construct an archive
   contents:
   - build_metadata