Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ License: MIT + file LICENSE
BugReports: https://github.com/doi-NPS/EMLeditor/issues
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.3
Remotes:
doi-NPS/QCkit
Imports:
Expand All @@ -43,15 +42,16 @@ Imports:
curl,
mockr,
rlang,
ISOcodes
ISOcodes,
sf
Suggests:
stargazer,
knitr,
rmarkdown,
testthat (>= 3.0.0),
QCkit,
sf,
withr
Config/testthat/edition: 3
URL: https://github.com/doi-nps/EMLeditor, https://doi-nps.github.io/EMLeditor/
VignetteBuilder: knitr
Config/roxygen2/version: 8.0.0
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# EMLeditor v1.2.1 (Development version)

## 2026-08-05
* Update DESCRIPTION: move sf from Suggests to Imports. Hopefully fixes issues with `set_content_units` etc.

## 2026-07-09
* Update `set_datastore_doi()` to include information or download tags in the data table URL by calling `set_data_urls()`
* Update `set_doi()` to including information or download tag in the data table URL by calling `set_data_urls()`
Expand Down
49 changes: 34 additions & 15 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ knitr::opts_chunk$set(

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R-CMD-check](https://github.com/DOI-NPS/EMLeditor/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/DOI-NPS/EMLeditor/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/DOI-NPS/EMLeditor/graph/badge.svg)](https://app.codecov.io/gh/DOI-NPS/EMLeditor)
<!-- badges: end -->

# EMLeditor
Expand All @@ -30,30 +29,48 @@ The goal of EMLeditor is to edit EML-formatted xml files. Specifically, EMLedito

## Installation and updates

You can install and update the development version of EMLeditor from [GitHub](https://github.com/) with:
You can install and update the development version of EMLeditor from
[GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pkg_install("nationalparkservice/EMLeditor")
pak::pkg_install("doi-nps/EMLeditor")

# alternatively:
remotes::install_github("doi-nps/eMLeditor")
```

To install all the packages in the [NPSdataverse](https://github.com/nationalparkservice/NPSdataverse) (including EMLeditor):
To install all the packages in the
[NPSdataverse](https://github.com/doi-nps/NPSdataverse)
(including EMLeditor):

``` r
pak::pkg_install("nationalparkservice/NPSdataverse")
pak::pkg_install("doi-nps/NPSdataverse")
#alternatively:
remotes::install_github("doi-nps/NPSdataverse")
```

## Workflow outline

EMLeditor comes with a template Rmarkdown script that you can edit to generate a fully fledged EML document. The script includes and accompanying documentation includes information on:

1) Generating an initial EML document using the R/EMLassemblyline package functions
2) Adding in NPS specific and DataStore specific EML elements using the R/EMLeditor package functions
3) Generating a draft data package reference on DataStore and incorporating DOIs into the metadata
4) Checking the EML document to make sure it is schema-valid and passes all the necessary tests for uploading to DataStore (using the `run_congruence_checks()` function from the [DPchecker](https://nationalparkservice.github.io/DPchecker/) package)
5) Uploading a completed data package to DataStore

Please *DO NOT ACTIVATE* the DataStore reference: prior to activation, data packages need to be reviewed via a yet-to-be-created process.
EMLeditor comes with a template Rmarkdown script that you can edit to
generate a fully fledged EML document. The script includes and
accompanying documentation includes information to:

1) Generate an initial EML document using the R/EMLassemblyline
package functions
2) Add NPS specific and DataStore specific EML elements using the
R/EMLeditor package functions
3) Generate a draft data package reference on DataStore and
incorporate DOIs into the metadata
4) Check the EML document to make sure it is schema-valid and passes
all the necessary tests for uploading to DataStore (using the
`run_congruence_checks()` function from the
[DPchecker](https://doi-nps.github.io/DPchecker/)
package)
5) Upload a completed data package to DataStore

Please *DO NOT ACTIVATE* the DataStore reference: prior to activation,
data packages need to be reviewed. Use the [Data Package Review Checklist](https://irma.nps.gov/DataStore/Reference/Profile/2306391?Inv=TRUE) to complete the review.

## Accessing the EML creation script

Expand All @@ -63,4 +80,6 @@ To access the EML creation script from within EMLeditor, install (or update) the

If you use EMLeditor functions to alter your metadata (e.g. "set" class functions) they will also silently add the National Park Service as a publisher (including location, [ROR id](https://ror.org/), etc) to your metadata unless you set NPS=FALSE. If you leave the default setting as NPS=TRUE, EMLeditor will also assume the data package is being created "by or for the NPS" and add that information to the metadata.

EMLeditor will also add information about the version of EMLeditor you used to edit your metadata (for instance if you used "set" class functions).
EMLeditor will also add information about the version of EMLeditor you
used to edit your metadata when you use “set” class functions.

35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- badges: start -->

[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R-CMD-check](https://github.com/doi-nps/EMLeditor/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/doi-nps/EMLeditor/actions/workflows/R-CMD-check.yaml)
[![R-CMD-check](https://github.com/DOI-NPS/EMLeditor/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/DOI-NPS/EMLeditor/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

# EMLeditor
Expand Down Expand Up @@ -32,36 +33,37 @@ remotes::install_github("doi-nps/eMLeditor")
```

To install all the packages in the
[NPSdataverse](https://github.com/doi-nps/NPSdataverse)
(including EMLeditor):
[NPSdataverse](https://github.com/doi-nps/NPSdataverse) (including
EMLeditor):

``` r
pak::pkg_install("doi-nps/NPSdataverse")
#alternatively:
remotes::install_github("doi-nps/NPSdataverse)
remotes::install_github("doi-nps/NPSdataverse")
```

## Workflow outline

EMLeditor comes with a template Rmarkdown script that you can edit to
generate a fully fledged EML document. The script includes and
accompanying documentation includes information on:
accompanying documentation includes information to:

1) Generating an initial EML document using the R/EMLassemblyline
package functions
2) Adding in NPS specific and DataStore specific EML elements using the
1) Generate an initial EML document using the R/EMLassemblyline package
functions
2) Add NPS specific and DataStore specific EML elements using the
R/EMLeditor package functions
3) Generating a draft data package reference on DataStore and
incorporating DOIs into the metadata
4) Checking the EML document to make sure it is schema-valid and passes
3) Generate a draft data package reference on DataStore and incorporate
DOIs into the metadata
4) Check the EML document to make sure it is schema-valid and passes
all the necessary tests for uploading to DataStore (using the
`run_congruence_checks()` function from the
[DPchecker](https://doi-nps.github.io/DPchecker/)
package)
5) Uploading a completed data package to DataStore
[DPchecker](https://doi-nps.github.io/DPchecker/) package)
5) Upload a completed data package to DataStore

Please *DO NOT ACTIVATE* the DataStore reference: prior to activation,
data packages need to be reviewed via a yet-to-be-created process.
data packages need to be reviewed. Use the [Data Package Review
Checklist](https://irma.nps.gov/DataStore/Reference/Profile/2306391?Inv=TRUE)
to complete the review.

## Accessing the EML creation script

Expand All @@ -82,5 +84,4 @@ NPS=TRUE, EMLeditor will also assume the data package is being created
“by or for the NPS” and add that information to the metadata.

EMLeditor will also add information about the version of EMLeditor you
used to edit your metadata (for instance if you used “set” class
functions).
used to edit your metadata when you use “set” class functions.
6 changes: 3 additions & 3 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/CONTRIBUTING.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading