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

Harmonize with RO-crate profile(s) #140

Open
wants to merge 7 commits into
base: dev
Choose a base branch
from
Open

Harmonize with RO-crate profile(s) #140

wants to merge 7 commits into from

Conversation

kMutagene
Copy link
Member

This PR will take care of the Scaffold spec part of #135.

(eventually)
closes #139
closes #138
closes #136

@kMutagene kMutagene changed the base branch from release to dev February 27, 2025 07:47
@kMutagene kMutagene marked this pull request as draft February 27, 2025 07:47
@kMutagene kMutagene requested review from HLWeil and Brilator February 27, 2025 07:48
@kMutagene
Copy link
Member Author

@Brilator can you have a look at the Licensing part of this PR and tell me if it is in line what was discussed in https://github.com/orgs/nfdi4plants/discussions/11?

Copy link
Member

@Brilator Brilator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Licensing part LGTM

In other words, the creator has the exclusive right to decide how the ARC is used, distributed, or modified.
To allow others to use, distribute, or modify the ARC, the creator(s) can choose a more permissive license. Examples of permissive licenses include the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) and the [MIT License](https://opensource.org/licenses/MIT).

Obviously, more permissive licenses are more in line with the F**A**I**R** principles, as they allow others to **A**ccess and **R**euse ARCs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a bit ambiguous.
Does it mean less permissive, i.e. CC-BY = FAIR, CC-BY-NC-SA = less permissive = less FAIR?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can make a point that any copyright makes something less accessible in the broadest sense, as there are more than 0 restrictions on the accessibility.

However, from the FAIR definition site itself:

The ‘A’ in FAIR does not necessarily mean ‘open’ or ‘free’. Rather, it implies that one should provide the exact conditions under which the data are accessible

So adding any license makes the ARC more FAIR, as that clarifies (some) conditions of access. I would however argue that the general public sentiment leans towards ‘open’ or ‘free’ being more FAIR than a dataset that applies FAIR principles but is not openly accessible. You can for example also have licenses that allow full access but prevent the R in FAIR via prohibiting any re-use.

So long story short i am ambiguous on purpose here, but open for suggestions

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Under further investigation, licenses are more on the side of the R in FAIR. Access obviously cannot be handled by them directly, as once you can read the license you obviously have access to the ARC. will clarify


Obviously, more permissive licenses are more in line with the F**A**I**R** principles, as they allow others to **A**ccess and **R**euse ARCs.
However, **the choice of license is up to the creator(s) of the ARC**.
It may not be possible to openly share ARCs due to legal or ethical constraints, for example when sensitive clinical data is involved.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

legal (e.g. patenting or IPR)

@@ -63,9 +63,11 @@ The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RE

## Extensions

The ARC specification can be extended in a backwards compatible way and will evolve over time. This is accomplished through a community-driven ARC discussion forum and pull request mechanisms.
The ARC specification can be extended and will evolve over time. This is accomplished through a community-driven ARC discussion forum and pull request mechanisms.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


All changes that are not backwards compatible with the current ARC specification will be implemented in ARC specification v2.0.
Backwards compatible changes, e.g. the addition of new optional metadata fields, will be implemented in _minor version increases_.
All changes that are not backwards compatible with the current ARC specification will be implemented in _major version increases_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 👍 👍

@kMutagene kMutagene linked an issue Feb 28, 2025 that may be closed by this pull request

## Inputs and Outputs

Each annotation table sheet MUST contain at most one `Input` and at most one `Output` column, which denote the Input and Output node of the `Process` node respectively. They MUST be formatted in the pattern `Input [<NodeType>]` and `Output [<NodeType>]`.
Each annotation table sheet MAY contain at most one `Input` column.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! <3

@@ -565,6 +565,9 @@ This section MUST contain the following labels, with the specified datatypes for

| Label | Datatype | Description |
|----------------------------------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Assay Identifier | String | A mandatory unique identifier, either a temporary identifier supplied by users or one generated by a repository or other database. For example, it could be an identifier complying with the LSID specification. A value MUST be given for this label. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@@ -340,6 +342,28 @@ Use of `folder specific pattern` relative paths from `Assay1` and `Assay2` `Data

Note, that to reference `Data` which is part of `Assays1` in `Assay2`, the `general pattern` is necessary either way. Therefore it is considered the more broadly applicable and recommended pattern.

## Licensing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add to TOC

@@ -340,6 +342,28 @@ Use of `folder specific pattern` relative paths from `Assay1` and `Assay2` `Data

Note, that to reference `Data` which is part of `Assays1` in `Assay2`, the `general pattern` is necessary either way. Therefore it is considered the more broadly applicable and recommended pattern.

## Licensing

_Disclaimer: This is not legal advice, when in doubt consult a legal professional in your jurisdiction_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Section reads great!

@HLWeil HLWeil mentioned this pull request Feb 28, 2025
@kMutagene kMutagene linked an issue Mar 3, 2025 that may be closed by this pull request
@kMutagene kMutagene marked this pull request as ready for review March 3, 2025 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants