forked from nationalparkservice/EMLeditor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
65 lines (43 loc) · 3.55 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
`r lifecycle::badge('experimental')`
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental) [](https://www.codefactor.io/repository/github/roblbaker/emleditor)
[](https://github.com/nationalparkservice/EMLeditor/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
# EMLeditor
## Overview
The goal of EMLeditor is to edit EML-formatted xml files. Specifically, EMLeditor provides many functions that will be useful to the U.S. National Park Service when generating metadata for statistical data packages uploaded to DataStore. NPS affiliation is assumed as default. However, the functions for viewing and editing metadata may be useful to people outside the NPS.
## Installation and updates
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")
```
To install all the packages in the [NPSdataverse](https://github.com/nationalparkservice/NPSdataverse) (including EMLeditor):
``` r
pak::pkg_install("nationalparkservice/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.
## Accessing the EML creation script
To access the EML creation script from within EMLeditor, install (or update) the EMLeditor package and restart R. From within Rstudio, select the "File" drop-down menu and choose "New File" (the first option). From within the "New File" menu, select "Rmarkdown...". In the pop-up menu, select "From Template on the left hand side. Then choose the template, "Editable_EML_Creation_Workflow {EMLeditor}" then click "OK".
## Additional considerations
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).