Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A controlled vocabulary reflects agreement on terminology used to label concepts. When research organisations agree to use common language the discovery, interpretation, understanding and reuse of research data is improved. For more information on controlled vocabularies, please see the ANDS ARDC guide to vocabularies and research data .


ANDS ARDC provides a Vocabulary Service for use by our partners. The service supports research organisations to publish and discover controlled vocabularies.

...

In order to support our partners in making their vocabularies available and browsable via the ANDS ARDC Vocabulary Service, we provide this guide and accompanying ingestion template, which outline a transformation and ingestion process. In addition, section 5 details the discussion of a completed example of this transformation and ingestion process. If you have any additional questions about the transformation or ingestion of your vocabulary, please contact services@andsservices@ardc.orgedu.au .



2. Getting started: Questions about your vocabulary

...

  • Examples of formats in which a vocabulary may be stored: Spreadsheet, CSV, PDF, text, HTML, SKOS, database tables, etc.

  • Has ANDS ARDC already developed a transformation and ingestion process for that format? Has your organization developed a process to transform the current format to SKOS? If not, we will work with you to develop a process.

  • Note : This is a guide for cases in which there are vocabularies that have a semantic model that can be adequately expressed within the constraints of a spreadsheet or comma separated values (CSV) format. For information about the transformation and ingestion of vocabularies that are maintained/stored in other formats, please consult our other transformation and ingestion guides.

...

  • What are the elements used to describe metadata about the concepts?

  • What do these elements mean?

  • How do the current elements used to describe metadata about the concepts map to the ANDS ARDC Vocabulary Service ingestion template?

In order for your vocabulary to be ingested into the ANDS ARDC Vocabulary Service, the information provided in the original format needs to be translated into the ingestion template provided by ANDSARDC. The template allows ANDS ARDC partners to indicate what information about the vocabulary should be captured within the following elements:

 

URI

 

<uri>
  • An identifier which is guaranteed to be unique among all identifiers used within the vocabulary. This identifier will be used to create a unique URI for each vocabulary concept.

  • If you do not have a predefined URI structure you’d like to use with your vocabulary, ANDS ARDC can provide support in this decision.

  • The URI column is optional for ingestion.

Scheme

 

<scheme>
  • Scheme is an element that allows you to designate a machine-friendly, unique string of characters for your vocabulary.

  • The Scheme column is optional for ingestion.

Concept

 

<concept>
  • Concept is an element that makes it possible to assign a machine-friendly, unique string of characters for each concept.

  • Information captured in the concept element may also serve as the preferred label for concepts, if you choose not to make a distinction between concepts and their preferred labels.

  • At least one concept column is required for ingestion.

Preferred label

 

<prefLabel>
  • Preferred label is an element that makes it possible to assign a human-friendly, unique label for a concept.

  • If your vocabulary is multilingual, you may use the language tag to provide Preferred labels in multiple languages ( see Language Tag below ).

  • The Preferred label column is optional for ingestion.

Alternate label

 

<altLabel>
  • Alternate Label is an element that makes it possible to assign an unauthorized name to a concept.

  • An example might be a preferred label for the concept “fava bean” and an alternate label of “broad bean.”

  • The Alternate label column is optional for ingestion.

Hidden label

<hiddenLabel>
  • Hidden Label is an element that makes it possible to provide a label for a resource that needs to be accessible to applications performing text-based indexing and search operations, but not visible otherwise.

  • Hidden labels may be used to include misspelled variants, jargon, or colloquialisms of other labels of the concept.

  • An example might be a preferred label for the concept “potato” and hidden labels of “potatoe,” “tater” and “spud.”

  • The Hidden label column is optional for ingestion.

Notation

 

<notation>
  • Notation is an element that captures alphanumeric codes such as "T58.5" or "303.4833" used to uniquely identify a concept within the scope of a given vocabulary, but is not normally recognizable as a word or sequence of words in any natural language.

  • Classification codes or schemes may be captured using the notation element.

  • The Notation column is optional for ingestion.

Scope note

 

<scopeNote>
  • Scope note is an element that explains and clarifies what is meant and what is not meant in the definition of the concept and in its use in the vocabulary.

  • An example might be a preferred label for the concept “vegetable” and a scope note of “ The concept vegetable excludes other main types of plant food, fruits, nuts and cereal grains but includes seeds such as pulses.

  • The Scope note column is optional for ingestion.

Example

 

<example>
  • Example is an element that details an instance serving as an illustration for other instances of the concept.

  • An example might be a preferred label for the concept “potato” and an example of “ The prize potato, grown by Peter Glazebrook, tips the scales at a whopping 8lbs 4oz (3.76kg), smashing the previous world record by 9oz. The vegetable, Peter's Kondor variety, was put on show on Friday at the National Gardening Show in Shepton Mallet, Somerset.

  • The Example column is optional for ingestion.

Definition

 

<definition>
  • Definition is an element that supplies a complete explanation of the intended meaning of a concept.

  • An example might be a preferred label for the concept “potato” and a definition of “ The potato is a starchy, tuberous crop from the perennial nightshade Solanum tuberosum L .”

  • The Definition column is optional for ingestion.

Exact match

<exactMatch>  

Close match

<closeMatch>  

Related match

<relatedMatch>  

Broader match

<broaderMatch>  

Broader

<broader>  

Related

<related>  

 

...

Info

This is not a complete list of all elements which can be captured for your vocabulary in the ANDS ARDC Vocabulary Service. If your organization captures extra information that does not fall under the listed elements or tag, we can work with you to create a solution for including that information in your transformation. Please contact services@andsservices@ardc.orgedu.au  if you have any questions about your transformation process.

...

  • Are there any additional requirements of the vocab owners or other stakeholders that might impact the transformation or ingestion of the vocabulary into the ANDS ARDC Vocabulary Service?

  • Have all non-ingestible ( non-ASCII ) symbols been removed?

  • Is the vocabulary multilingual (does it include content in multiple languages)? If so, please provide ANDS ARDC with a list of languages used in the vocabulary prior to ingestion.

...

Info

This is just one example of the transformation of a vocabulary, and is meant to be used as a learning tool. The steps taken in order to transform your vocabulary may vary from those outlined below. Please contact services@andsservices@ardc.orgedu.au  if you have any questions about your transformation process.

...

In order for ANZSRC-FOR to be ingested into the ANDS ARDC Vocabulary Service, the content provided in the original spreadsheet needs to be entered into the ingestion template provided by ANDSARDC. The template allows us to indicate what original vocabulary content should be captured within the following elements:

...

Info

This is not a complete list of all elements which can be captured for your vocabulary in the ANDS ARDC Vocabulary Service. If your organization captures extra information that does not fall under the listed elements or tag, we can work with you to create a solution for including that information in your transformation. Please contact services@andsservices@ardc.orgedu.au  if you have any questions about your transformation process.

...

The ingestion template allows for ANDS ARDC partners to capture information about the hierarchical structure of their vocabulary and metadata about the concepts in one document.

...