Skip to content

Home

Jump to bottom
Emmanuel Blondel edited this page Aug 2, 2020 · 5 revisions

atom4R - Tools to read/write/publish metadata as Atom XML format

DOI

Provides tools to read/write/publish metadata based on the Atom XML syndication format. This includes support of Dublin Core XML implementation, and a client to APIs implementing the AtomPub SWORD API specification.

If you wish to sponsor atom4R, do not hesitate to contact me

Many thanks to the following organizations that have provided fundings for strenghtening the atom4R package:

Table of contents

1. Overview
2. Package status
3. Credits
4. User guide
   4.1 Installation
   4.2 Write and Read Atom XML records
      4.2.1 Atom Feed
      4.2.2 Atom Entry
      4.2.3 Dublin Core Entry
   4.3 Publish Atom XML records
      4.3.1 SWORD API for Dataverse
5. Issue reporting

1. Overview and vision

The atom4R package rovides tools to read/write/publish metadata based on the Atom XML syndication format. This includes support of Dublin Core XML implementation, and a client to APIs implementing the AtomPub SWORD API specification.

atom4R is jointly developed together with the geoflow which intends to facilitate and automate the production of geographic metadata documents and their associated datasources, where atom4R is used to assign DOIs and cross-reference these DOIs in other metadata documents such as geographic metadata (ISO 19115/19139) hosted in metadata catalogues and open data portals.

2. Development status

  • June 2020: Inception. Code source managed on GitHub.
  • Coming soon: Publication on CRAN.

3. Credits

(c) 2020, Emmanuel Blondel

Package distributed under MIT license.

If you use atom4R, i would be very grateful if you can add a citation in your published work. By citing atom4R, beyond acknowledging the work, you contribute to make it more visible and guarantee its growing and sustainability. For citation, please use the DOI: DOI

4. User guide

4.1 How to install atom4R in R

For now, the package can be installed from Github

install.packages("devtools")

Once the devtools package loaded, you can use the install_github to install atom4R. By default, package will be installed from master which is the current version in development (likely to be unstable).

require("devtools")
install_github("eblondel/atom4R")

4.2 Write and read Atom XML records

TODO

4.2.1 Atom Feed

TODO

4.2.2 Atom Entry

TODO

4.2.3 Dublin Core Entry

TODO

4.3 Publish Atom XML records with AtomPub

TODO

4.3.1 SWORD API for Dataverse

TODO

5. Issue reporting

Issues can be reported at https://github.com/eblondel/atom4R/issues

Clone this wiki locally