Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tabular template for multiple term requests #95

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/new-multiple-term-request-issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: New multiple term request issue template
about: Please use this template to request one or multiple new terms for the ontology
title: "[NTR]"
labels: New Term Request
assignees: ''

---

For new term requests (NTRs), please provide the following information:

| Preferred term label | Synonyms | Textual definition | Link to [CHARISMA Wiki equivalent] | Suggested parent term | Axiomatization | Examples | Remarks |
| -------------------- | -------- | ------------------ | ---------------------------------- | --------------------- | -------------- | -------- | ------- |
| | | [definition1] | | | | | [note1] |
Zack-83 marked this conversation as resolved.
Show resolved Hide resolved


[definition1]: ## "You may use this syntax for lengthy sentences, in order to maintain the code of the table legible. This applies specially to definitions and remarks. The text becomes visible upon hovering the mouse pointer over the placeholder text."

[note1]: ## "..."




## Preferred term label

(e.g., spectral window range maximum)

## Synonyms

(e.g., acquisition band maximum)

## Textual definition

The definition should be understandable even for non-specialists. Include a DOI or URL to refer to any relevant publication that provides additional information about the suggested term.

## Link to [CHARISMA Wiki equivalent]
The CHARISMA project wiki contains terms for Raman specific and related concepts identified by domain experts of the CHARISMA team. In order to reuse this expertise, we've agreed with the CHARISMA team to link between the terms in this wiki and the terms in VISBO. For example https://wiki.charisma.ideaconsult.net/wiki/Item:Q57 is mentioned as definition source for the VIBSO class *region of interest*.

## Suggested parent term

Please look in the hierarchy in a browser such as the [NFDI4Chem TS](https://terminology.nfdi4chem.de/ts/ontologies/vibso)

## Examples

Please provide a more detailed description that examplifies how the term is supposed to be used, in terms of what it is suppose to repesent (e.g. a concept or a relation).

## Attribution

If you would like a nanoattribution, please indicate your ORCID id. (out of the table)

[CHARISMA Wiki equivalent]: https://wiki.charisma.ideaconsult.net/wiki/List_of_all_terms

7 changes: 6 additions & 1 deletion docs/competency_questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,17 @@ As previously mentioned, VIBSO's scope is the semantic description of vibrationa
* What kind of vibrational spectroscopy was performed (as detailed as possible: enhanced, resonant, stimulated, coherent, anti-Stokes...)?

* In what context was it performed, e.g. as part of what study or investigation?
> Requires to clarify the hierarchy in the ontology: e.g. experiment < investigation < project

Zack-83 marked this conversation as resolved.
Show resolved Hide resolved
~* What protocol and devices were used?~
> Somehow redundant with the following one; "what protocol" meaningful only within a workgroup
Zack-83 marked this conversation as resolved.
Show resolved Hide resolved

* What devices were used?

* What were the protocol parameters & device configurations?

* Who was involved in the assay? (identified by a PID like ORCID at best)
> It is more probable that the users document the names of the co-authors than the academic degree / role

* What was the assayed sample, including its relevant attributes (e.g. substrate, production procedure, pre-treatment)?

Expand All @@ -30,4 +35,4 @@ As previously mentioned, VIBSO's scope is the semantic description of vibrationa

* Find me a suitable solvent which is compatible with sample XY, i.e. which does not have any Raman peak or band between wavenumbers W1 and W2.

This list represents only a first draft and needs to be thoroughly discussed with the domain experts and the NFDI4Chem community.
This list represents only a first draft and needs to be thoroughly discussed with the domain experts and the NFDI4Chem community.
Loading