[** ADD YOUR ABSTRACT HERE]...example local reference listed in localBiblio section of HTML document head ([[!DOE13]])

[** HERE'S AN EXAMPLE FIGURE] .
my figure
My Figure

NIDM Family of Documents

This document is part of the NIDM family of documents.

Please Send Comments

[** ADD YOUR COMMENT OR MAILING LIST ADDRESS HERE]. All comments are welcome.

Introduction

[** ADD NAME AND DESCRIPTION OF YOUR NIDM COMPLIANT OBJECT MODEL HERE]

Structure of this Document

Section 2 [** ADD DESCRIPTION OF YOUR SECTIONS HERE..WE SUGGEST AN OVERVIEW OF TYPES AND RELATIONS SECTION]

Section 3 [** ADD DESCRIPTION OF YOUR SECTIONS HERE...WE SUGGEST AN EXAMPLES SECTION]

Notational Conventions

The key word "OPTIONAL" in this document is to be interpreted as described in [RFC2119].

Namespaces

[** WE SUGGEST YOU ENUMERATE THE NAMESPACES USED IN YOUR DOCUMENT]

Table 1 ◊: Prefix and Namespaces used in this specification
prefixnamespace IRI definition
nidmhttp://purl.org/nidash/nidm#The NIDM namespace
provhttp://www.w3.org/ns/prov#The PROV namespace [[prov-dm]]
xsdhttp://www.w3.org/2000/10/XMLSchema#XML Schema Namespace [[XMLSCHEMA11-2]]
(others)(various)All other namespace prefixes are used in examples only.
In particular, IRIs starting with "http://example.com" represent
some application-dependent IRI [[RFC3987]]

Overview

[** ADD A BRIEF OVERVIEW OF YOUR OBJECT MODEL HERE]

Domain covered by [** INSERT NAME OF YOUR OBJECT MODEL]

[** BRIEFLY DESCRIBE YOUR DOMAIN].

[** DESCRIBE THE CORE STRUCTURES IN YOUR OBJECT MODEL]

The concepts found in the core of [** ADD YOUR OBJECT MODEL NAME HERE] are introduced in the rest of this section.

Core Structures Overview

The core [** ADD YOUR OBJECT MODEL NAME HERE] structures are presented in [** ADD REFERENCE TO YOUR UML DIAGRAM BELOW]. The color coding corresponds to the prov:type (blue: prov:entity, red: prov:activity).
Core structures
Core structures overview UML diagram

Re-use of PROV-DM Structures

PROV relations used in [** ADD YOUR OBJECT MODEL NAME HERE] are summarized in Table 2.

Table 2 ◊: PROV relations in use in [** ADD YOUR OBJECT MODEL NAME HERE AND CHANGE THE LIST OF RELATIONS IN TABLE THAT MATCH YOUR OBJECT MODEL]
NIDM-Results ConceptsTypes or Relation (PROV concepts)NameOverview
Generation PROV Relations
WasGeneratedBy PROV-DM wasGeneratedBy
UsageUsedPROV-DM used
DerivationWasDerivedFromPROV-DM wasDerivedFrom

[** MODEL FITTING...WE CHOSE TO SEPARATE OUR UML DIAGRAM INTO MODEL FITTING AND INFERENCE SECTIONS]

Table 2 ◊: Mapping of [** ADD NAME OF YOUR OBJECT MODEL HERE..NICE TO HAVE A MAPPING BETWEEN THE CORE CONCEPTS IN YOUR MODEL TO PROV-DM ENTITIES, AGENTS, AND ACTIVITIES] Core Concepts to types and relations and PROV core concepts
[** ADD YOUR OBJECT MODEL NAME HERE] ConceptsTypes or Relation (PROV concepts)NameOverview
EXAMPLE NIDM-Results Types
(PROV Entities)
EXAMPLE
EXAMPLE2 EXAMPLE2
EXAMPLE3 EXAMPLE3
ACTIVITY1 NIDM-Results Types
(PROV Activities)
ACTIVITY1
ACTIVITY2 ACTIVITY2

EXAMPLE

The EXAMPLE entity used by the EXAMPLE2 entity represents .... The optional attribute THIS IS A DEFINITION of type xsd:boolean indicating the presence or absence of ...

[** ADD EXAMPLES OF THE ENTITY CODE USING THE PRE CLASS AS SHOWN HERE]

entity(niiri:data_id,
						    [prov:type = 'nidm:Data',
						    prov:type = 'prov:Collection',
						    prov:label = "Data" %% xsd:string,
						    nidm:grandMeanScaling = "true" %%xsd:boolean,
						    nidm:targetIntensity = "100" %% xsd:float,
						    nidm:medianIntensity = "115.32" %% xsd:float])

EXAMPLE2

EXAMPLE3

ACTIVITY1

ACTIVITY2

[** INFERENCE...WE CHOSE TO SEPARATE OUR UML DIAGRAM INTO MODEL FITTING AND INFERENCE SECTIONS]

[** ADD DESCRIPITION AND TABLES IN THIS SECTION SAME AS MODEL FITTING SECTION ABOVE]
Table 2 ◊: Mapping of [** ADD NAME OF YOUR OBJECT MODEL HERE..NICE TO HAVE A MAPPING BETWEEN THE CORE CONCEPTS IN YOUR MODEL TO PROV-DM ENTITIES, AGENTS, AND ACTIVITIES] Core Concepts to types and relations and PROV core concepts
[** ADD YOUR OBJECT MODEL NAME HERE] ConceptsTypes or Relation (PROV concepts)NameOverview
EXAMPLE NIDM-Results Types
(PROV Entities)
EXAMPLE
EXAMPLE2 EXAMPLE2
EXAMPLE3 EXAMPLE3
ACTIVITY1 NIDM-Results Types
(PROV Activities)
ACTIVITY1
ACTIVITY2 ACTIVITY2

EXAMPLE

The EXAMPLE entity used by the EXAMPLE2 entity represents .... The optional attribute THIS IS ANOTHER DEFINITION of type xsd:boolean indicating the presence or absence of ...

EXAMPLE2

EXAMPLE3

ACTIVITY1

ACTIVITY2

Illustration of [** ADD YOUR OBJECT MODEL NAME HERE] by an example.

[** ADD LINK TO GRAPH OF YOUR OBJECT MODEL..WE SUGGEST USING PROVSTORE (provstore ) TO CREATE]

[** WE SUGGEST A PROV-N SERIALIZATION EXAMPLE...WE SUGGEST USING PROV TOOLBOX TO CREATE]

[** WE SUGGEST A TURTLE SERIALIZATION EXAMPLE...WE SUGGEST USING PROVSTORE (https://provenance.ecs.soton.ac.uk/store/) TO CREATE]