Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.19 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.19 KB

ResearchMetadata

Metadata extraction from the Pure Research Information System and transformation of the metadata into the DataCite format.

Status

Gem Version Maintainability

Installation

Add this line to your application's Gemfile:

gem 'research_metadata'

And then execute:

$ bundle

Or install it yourself as:

$ gem install research_metadata

Usage

Configuration

Create a hash for passing to a transformer.

config = {
  url:      'https://YOUR_HOST/ws/api/59',
  username: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD',
  api_key:  'YOUR_API_KEY'
}

Transformation

Configure a transformer for a Pure dataset.

transformer = ResearchMetadata::Transformer::Dataset.new config

Give it a Pure identifier and a DOI...

metadata = transformer.transform id: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx',
                                 doi: '10.1234/foo/bar/1'

...and get DataCite-ready metadata.