You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/metadata.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,15 @@ It controls the creation workflow.
23
23
The creation from the metadata perspective is as follows:
24
24
25
25
1.`init` stores the files for a new ERC in a directory.
26
-
1.`extract` uses `metaextract.py` ([docs](https://github.com/o2r-project/o2r-meta#2-metaextract)) to analyse the incoming ERC and creates new files with _raw_ metadata for each of the scanned files. Currently the following types of files will be considered: _.r, .rmd, .shp, "bagit.txt"_. Future releases of the extractor will be likely to consider _.tex, .json (geojson), .jp2, .tiff_ and more.
26
+
1.`extract` uses `metaextract.py` ([docs](https://github.com/o2r-project/o2r-meta#2-metaextract)) to analyse the incoming ERC and creates new files with _raw_ metadata for each of the scanned files. Currently the following types of files will be considered: _.r, .rmd, netcdf, "bagit.txt"_. Future releases of the extractor will be likely to consider _.tex, .json (geojson), .jp2, .tiff_ and more.
27
27
This raw metadata itself is _schema-less_ and non-semantic.
28
28
The processed files are in conceptual competition for the best representative of the working directory's meta information, i.e. there will be only one main output, ideally represented by the most complete set of metadata.
29
29
By default the competing bits of information will also be preserved in `.erc/metadata_raw_<filename>.json` where _filename_ is an identifier based on the original source file.
30
30
- output file: `.erc/metadata_raw.json`
31
31
- database field: `<compendium>.metadata.raw`
32
32
1.`broker` uses `metabroker.py` ([docs](https://github.com/o2r-project/o2r-meta#5-metabroker)) to translate the _raw_ metadata in `json` to _o2r_ metadata in `json` as being compliant to the o2r json-schema.
33
-
- output file: `.erc/metadata_o2r.json`
34
-
- database field: `<compendium>.metadata.o2r`
33
+
- output file: `.erc/metadata_o2r_X.json` (where `X` is the version number as set in the [o2r-map.json](https://github.com/o2r-project/o2r-meta/blob/master/broker/mappings/o2r-map.json) mapping file, e.g. _1_)
34
+
- database field: `<compendium>.metadata.o2r`
35
35
1. (`harvest` TBD; will connect to third party database endpoint via OAI-PMH to gather additional information for the enrichment of the o2r metadata collected via extraction)
36
36
1.`save` stores the new ERC to the database including the aforementioned metadata fields.
37
37
1.`user check` provides an interactive form to the uploading user to control and edit the suggested metadata.
@@ -54,9 +54,10 @@ It does not do any updating, brokering, or validation.
`zenodo` | [Deposition metadata](https://zenodo.org/dev#collapse-list16) | `json` | for storing full ERC in the Zenodo data repository; Zenodo also publishes metadata on [DataCite](https://datacite.org/)
`zenodo` | [Deposition metadata](https://zenodo.org/dev#collapse-list16) | `json` | for storing full ERC in the Zenodo data repository; Zenodo also publishes metadata on [DataCite](https://datacite.org/)
0 commit comments