bi-directional relationships added

Author: rosanna-smith

lib/rules.js

@@ -480,7 +480,7 @@ const PrimaryMaterial = {
   communicationMode: RepositoryCollection.communicationMode,
   inLanguage: {
     clause:
-      'MUST have a inLanguage property, or the RepositoryObject that is `partOf` MUST have a inLanguage property, referencing a Language item (language my be inhereted from the parent RepoObject)',
+      'MUST have an `inLanguage` property, or the RepositoryObject that is `isPartOf` MUST have an `inLanguage` property, referencing a Language item (language my be inhereted from the parent RepoObject)',
     validate({ error, results }, values) {
       if (!values || !values.length) {
         error('There is no language property');

profile-text/profile.md

@@ -50,8 +50,8 @@ This profile covers various kinds of crate metadata:
   the abstract structure of nested collections (e.g. collections/corpora or other
   curated datasets) and objects of study; linguistic Items, Sessions or Texts).
   This profile assumes that a repository (for example, an OCFL storage root,
-  with an API for accessing it) exists and that it can at a minimum support 
-  (a)  listing all items of the repository and returning their RO-Crate metadata, and 
+  with an API for accessing it) exists and that it can at a minimum support
+  (a) listing all items of the repository and returning their RO-Crate metadata, and
   (b) retrieving an item given its ID.
 
 - **Types of language data** - is this resource a dialogue? A written text? A
@@ -105,10 +105,21 @@ transmitted either as:
   Object data.
 
 Distributed Collections may reference member collections or Objects in
-hasMember property but should not include descriptions of Objects that
+\`hasMember\` property but should not include descriptions of Objects that
 are stored elsewhere in the repository.
 
-Objects are placed in a Collection using the \`memberOf\` property (\`pcdm:memberOf\`), which is required. The reverse may also be encoded using the \`hasMember\` property on a Collection.
+<br>
+
+## Bi-directional relationships
+
+| Term          | Inverse Of | Micro        |
+| ------------- | ---------- | ------------ |
+| \`hasPart\`   | ⟷          | \`isPartOf\` |
+| \`hasMember\` | ⟷          | \`memberOf\` |
+
+Objects are placed in a Collection using the \`memberOf\` property (\`pcdm:memberOf\`), which is required. The inverse will be encoded automatically using the \`hasMember\` property on a Collection. Similarly, if using \`hasMember\`, \`memberOf\` will also be automatically encoded.
+
+Depending on the data, one term relationship may be preferable. For example, if you are describing multiple files in a spreadsheet, it is easier to use \`isPartOf\` at the file level referencing the object it belongs to, rather than listing all the \`hasPart\` entries at the object level.
 
 The following diagram shows how these relationships are encoded in a single "bundled" RO-Crate.
 
@@ -132,7 +143,7 @@ repository developers.
     files.
 
   - The collection and all its files can easily be transferred in a
-    single transaction - say 20Gb total.
+    single transaction - say 20 GB total.
 
   - All the material in the corpus shares the same license for reuse.
 
@@ -142,9 +153,9 @@ repository developers.
 
   - The collection is not yet stable:
 
-    -   New items are being added or changed.
+    - New items are being added or changed.
 
-    -   There is a chance that some data may have to be taken down or withdrawn at the request of participants.
+    - There is a chance that some data may have to be taken down or withdrawn at the request of participants.
 
   - The total size of the collection will present challenges for
     data transfer.
@@ -161,7 +172,7 @@ objects such as PARADISEC collections which bring together items
 collected in a region or on a session with informants. This follows the
 Alveo usage:
 
-> Items \[*Objects* in this model\] are grouped into collections which might
+> Items \[_Objects_ in this model\] are grouped into collections which might
 > correspond to curated corpora such as ACE or informal collections such as a
 > sample of documents from the AustLit archive
 > ([http://www.austlit.edu.au/](http://www.austlit.edu.au/)).
@@ -172,7 +183,7 @@ resolvable ID (within the context of a repository or service) of the
 parent Collection. The Collection may also list its members in a hasMember
 property, but this is not required.
 
-The root dataset must have at least these \@type values: \["Dataset",
+The root dataset must have at least these \`@type\` values: \["Dataset",
 "RepositoryCollection"\]
 
 ### A RepositoryCollection:
@@ -187,28 +198,28 @@ An Object is a single unit linked to tightly related files, for example,
 a dialogue or session in a speech study, or a work (document) in a written
 corpus. This is based on the use of the term _Item_ in Alveo:
 
->The data model that we have developed for the storage of language
->resources is built around the concept of an item which corresponds
->(loosely) to a record of a single communication event. An item is
->often associated with a single text, audio or video resource but could
->include a number of resources, for example, the different channels of
->audio recording, or an audio recording and associated textual
->transcript. Items are grouped into collections which might correspond
->to curated corpora such as ACE or informal collections such as a
->sample of documents from the AustLit archive
->(<http://www.austlit.edu.au/>).
-><https://www.researchonline.mq.edu.au/vital/access/services/Download/mq:37347/DS01>
+> The data model that we have developed for the storage of language
+> resources is built around the concept of an item which corresponds
+> (loosely) to a record of a single communication event. An item is
+> often associated with a single text, audio or video resource but could
+> include a number of resources, for example, the different channels of
+> audio recording, or an audio recording and associated textual
+> transcript. Items are grouped into collections which might correspond
+> to curated corpora such as ACE or informal collections such as a
+> sample of documents from the AustLit archive
+> (<http://www.austlit.edu.au/>).
+> <https://www.researchonline.mq.edu.au/vital/access/services/Download/mq:37347/DS01>
 
 The definition of an object is necessarily loose and needs to reflect
 what data owners have chosen to do with their collections in the past.
 
 If an RO-Crate contains a single Object the Root Dataset would have a
 \`@type\` property of ["Dataset", "RepositoryObject"] with a
-conformsTo property pointing to the language-data-commons Object profile
+\`conformsTo\` property pointing to the language-data-commons Object profile
 (this document).
 
 If an RO-Crate contains an entire collection then each Object has a
-\`@type\` property of ["Dataset", "RepositoryObject"] and a conformsTo
+\`@type\` property of ["Dataset", "RepositoryObject"] and a \`conformsTo\`
 property referencing this document. For example:
 
 Objects SHOULD have files (which may be included in an RO-Crate for the
@@ -244,7 +255,6 @@ analysis of the \`PrimaryMaterial\` or \`DerivedMaterial\`.
 
 \`PrimaryMaterial\` may be a video or audio file if it is available or may be a ContextualEntity referencing a primary text such as a book.
 
-
 #### A [File, PrimaryMaterial]:
 
 ${rules.PrimaryMaterial}
@@ -253,10 +263,8 @@ ${rules.PrimaryMaterial}
 
 DerivedMaterial is a non-analytical derivation from PrimaryMaterial, for example, downsampled video or excerpted text.
 
-
 ${rules.DerivedMaterial}
 
-
 #### A [File, DerivedMaterial]:
 
 ${rules.DerivedMaterial}
@@ -274,12 +282,11 @@ ${rules.Annotation}
 CSV or similar tabular files are often used to represent transcribed
 speech or sign language data, sometimes also with time codes. To enable
 automated location of which column is which, use a [frictionless Table
-Schema](https://specs.frictionlessdata.io/table-schema/) described by a File entity in the crate. 
+Schema](https://specs.frictionlessdata.io/table-schema/) described by a File entity in the crate.
 
 For example:
 ${exampleEntities('art', ['art_schema.json'])}
 
-
 ### Language
 
 #### A [Language] entity:
@@ -290,7 +297,7 @@ ${rules.Language}
 
 ## Places
 
-The place in which data was collected may be indicated using the \`contentLocation\` property. 
+The place in which data was collected may be indicated using the \`contentLocation\` property.
 
 ${exampleEntities('paradisec-item-NT1-001', ['./', 'https://www.ethnologue.com/country/VU', '#Vanuatu'])}
 
@@ -301,7 +308,7 @@ ${exampleEntities('paradisec-item-NT1-001', ['./', 'https://www.ethnologue.com/c
 Identifiers for Objects and Collections MUST be URIs.
 
 Internally, identifiers for all entities that do not have their own URIs
-may use the Archive and Packaging identifier scheme ([ARCP]), which allows for a DNS-like namespacing of
+may use the Archive and Packaging identifier scheme (ARCP), which allows for a DNS-like namespacing of
 identifiers. For example, the Sydney Speaks corpus top-level
 collection would have the ID:
 
@@ -327,15 +334,15 @@ Some corpora express ages and other demographics of participants - this
 presents a data modelling challenge, as age and some other variables change
 over time, so if the same person appears over time then we need to have a
 base Person with DoB etc. and then time-based instances of the person
-with an age, social status, gender etc. *at that time*.
+with an age, social status, gender etc. _at that time_.
 
 There are three levels at which contributions to an object can be
 modelled:
 
 1.  Include one or more Person items as context in a crate and reference
     them with properties such as schema:creator or the
     language-data-commons contribution properties such as [ldac:compiler]
-    or [ldac:depositor]. The \@id of the person MUST be a URI and SHOULD
+    or [ldac:depositor]. The \`@id\` of the person MUST be a URI and SHOULD
     be re-used where the same person appears in multiple objects in a
     collection or repository.
 
@@ -363,12 +370,12 @@ modelled:
 
 Where data is collected from participants in a speech study with
 elicitation tasks such as "sessions" (see this [IMDI
-document]](https://www.mpi.nl/ISLE/documents/draft/ISLE_MetaData_2.5.pdf))
+document](https://www.mpi.nl/ISLE/documents/draft/ISLE_MetaData_2.5.pdf))
 or field interviews this can be recorded in metadata via the
 CollectionEvent class.
 
 The indirection in this conforms-to relationship is to allow multiple
-objects to have a conformsTo property which indicates that they conform
+objects to have a \`conformsTo\` property which indicates that they conform
 to the _same_ schema while having a local copy of the schema, as per
 RO-Crate best practice of having all local context to use a data
 packages in the package where possible.
@@ -393,9 +400,6 @@ Dakota: The University of North Dakota M.A.
 
 [https://www.mpi.nl/ISLE/documents/docs_frame.html](https://www.mpi.nl/ISLE/documents/docs_frame.html)
 
-
-
-
 [ldac:PersonSnapshot]: https://purl.archive.org/language-data-commons/terms#PersonSnapshot
 [ldac:depositor]: https://purl.archive.org/language-data-commons/terms#depositor
 [ldac:compiler]: https://purl.archive.org/language-data-commons/terms#compiler