Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
Removed naming as it is a duplicate now.
Updated semantic engine content to include schema library.
Added a highlight for OCAP/CARE data.
  • Loading branch information
carlyh-micb committed Nov 8, 2024
1 parent 2c8b840 commit 13b6cf9
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 43 deletions.
35 changes: 0 additions & 35 deletions docs/Data_Documentation/naming.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/Data_Documentation/semantic_engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,10 @@ Store your schema multiple ways.

Store the machine-readable schema bundle version and the .txt human-readable version together for best usability.

### Contributing to the schema library

The Data Hub project of Genome Canada is creating a [schema library](https://climatesmartagcollab.github.io/HUB-Harmonization/) as part of its mandate to help with data harmonization and the creation of data standards across project members.

After creating your data schema using the Semantic Engine you can upload your machine-readable schema bundle and generate the markdown readme. Select the Data Hub scenario to add your ICT team name, schema author and email address so that your schema is sorted correctly in the library and so that other Data Hub members can see what data you are producing.

- written by Carly Huitema
3 changes: 2 additions & 1 deletion docs/Data_Sharing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ nav_order: 8

Satisfying FAIR data management principles for data sharing involves several administrative and technical parts including hosting data, providing access permission, and enabling discovery of that data. These services need to be maintained beyond the life of the project.

_**Indigenous data has special governance concerns: For more information, see [OCAP & CARE](https://climatesmartagcollab.github.io/Documentation-en/ocapcare.html)**_.
{: .highlight }
Indigenous data has special governance concerns: For more information, see [OCAP & CARE](https://climatesmartagcollab.github.io/Documentation-en/ocapcare.html).

### Governance:

Expand Down
8 changes: 1 addition & 7 deletions docs/storage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,9 @@ nav_order: 5

Active data is that which is under current collection and analysis.

Recommended is the 3-2-1 rule: Save three copies of your data, on two different storage mediums, and one copy off site.
It is recommended that when saving your active research data you use the 3-2-1 rule: Save three copies of your data, on two different storage mediums, and one copy off site.


### Project file organization

Consider specifying file organization (in addition to file naming) conventions. The [TIER protocol](https://www.projecttier.org/tier-protocol/protocol-4-0/) may be a resource to consider for setting up project file structures.

Documentation that meets the specifications of the TIER Protocol contains all the data, scripts, and supporting information necessary to enable you, your instructor, or an interested third party to reproduce all the computations necessary to generate the results you present in the report you write about your project.

## Archive Data Storage

There are many resources available for data storage at the end of a research project.
Expand Down

0 comments on commit 13b6cf9

Please sign in to comment.