-
Notifications
You must be signed in to change notification settings - Fork 203
[ENH][BEP028] Specification update for BEP028 BIDS-Prov #2099
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
Draft
bclenet
wants to merge
315
commits into
bids-standard:master
Choose a base branch
from
bclenet:BEP028_spec
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
315 commits
Select commit
Hold shift + click to select a range
f5ea386
Entity Ids are BIDS URIs
bclenet c4e926d
Remove GeneratedByProv -> integrated into GeneratedBy for dataset lev…
bclenet 0a0368f
Entities allowed in prov-*_ent.json files
bclenet a851f8b
Remark
bclenet 2052b37
Entities allowed in prov-*_ent.json files
bclenet 8415096
Removing GeneratedByProv
bclenet ab8ccaf
GeneratedBy field for Entities allow arrays
bclenet 482c440
fMRIPrep example
bclenet be27631
Markdown lint
bclenet 05022aa
Merge branch 'master' into BEP028_spec
bclenet ab7872d
BIDS-Prov citation + Provenance example links
bclenet 535705c
Correcting typos
bclenet 8cf521f
Links from snippets to bids-examples
bclenet 2c43698
Links from snippets to bids-examples
bclenet d978907
Provenance graph for definitions
bclenet d4dabb4
Provenance example graph with neuro context
bclenet 5eb1ec3
Merge branch 'master' into BEP028_spec
bclenet 9381bf4
Remove unrelated changes
bclenet 5c83813
Typo and replace CAN by MAY
bclenet 891730b
Examples at the begining of subsections
bclenet 5181dd0
Uniqueness of ids
bclenet c20912c
Minimal example > consistency of Ids
bclenet ff4746a
Issue with dataset naming
bclenet 9f6eeae
Simplification in definitions
bclenet 2f05124
Deidentification
bclenet ca61869
Merge branch 'master' into BEP028_spec
bclenet 7345757
Removing prefix all
bclenet a3f5238
Remove unrelated changes
bclenet 242062c
Sidecargeneratedby precision
bclenet 4840a3e
Using markdown mermaid graph for provenance
bclenet 575c7c3
Scopes of provenance description
bclenet b80d616
Environments added in provenance context
bclenet ca88629
Removing non existing terms Entity Activity and Environment
bclenet 957f1d4
Entities description
bclenet bca8614
Descriptions for ids in metatadta
bclenet 9ca908f
Descriptions for ids in metatadta
bclenet 07b99a8
Removing caps to entity, activity, environment and software
bclenet 386fcc0
descriptions of suffixes
bclenet 8c484c7
@cmaumet review
bclenet 92ebb2c
@cmaumet review
bclenet ea8de55
GeneratedBy can be an array of objects (pipelines) or an activitiy Id
bclenet a426280
Removing groups of provenance
bclenet 1a9b496
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 5215609
GeneratedBy schema modification
bclenet f557eaa
Reorganize and consistency in naming
bclenet 32f80c7
Using identifier instead of
bclenet b0db166
Id for entities other than BIDS URI
bclenet 7dd01e6
Minimal example for study dataset
bclenet 3ff60df
Removing provenance metadata
bclenet 5f29549
Provenance file organization
bclenet df3c74f
Removing note about SidecarGeneratedBy
bclenet c9eda27
prov BIDS entity description
bclenet 92a2340
Update metaschema
effigies 7f08c35
Merge remote-tracking branch 'upstream/master' into BEP028_spec
effigies 26cf9e7
Update mkdocs.yml
effigies 9ee1518
fix metaschema
effigies aa2dda5
chore: codespell -w
effigies bfa49a6
Removing provenance records
bclenet bce7fef
Yaml lint
bclenet 213bc50
GeneratedBy is always an array
bclenet 2c9a817
GeneratedBy is always an array
bclenet bc713f5
Replacing Entities with ProvEntities
bclenet b72b224
Replacing entities with provEntities in schema and context
bclenet b52c9ff
New template for provenance files
bclenet a36511a
Provenance description file
bclenet 07727ba
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] e2abca5
Dataset names
bclenet 850a633
Templates for files in schema.rules.files.common
bclenet f5e40ca
Key concepts
bclenet 8fa98e3
provEntities for files and datasets are allowed in _ent provenance files
bclenet 4f20003
Light formatting
bclenet a84f0b8
Allow fragments in BIDS URIs
bclenet 1d1c7a9
provenance.tsv is under prov/
bclenet b43cae0
Fragments and BIDS URIs for datasets
bclenet c933736
Add first version of RDF paragraph
bclenet 6aa4a87
Moving provenance-context to src/
bclenet 0d8fc24
Codespell
bclenet f8eaaf2
Remark
bclenet bd9868c
Schema rules for provenance files
bclenet 0510344
Update src/modality-agnostic-files/provenance.md
cmaumet 5c1af72
GeneratedBy allowing single id
bclenet 33df071
GeneratedBy allowing single id
bclenet f855281
Checksum functions
bclenet e28be4f
Checksum functions
bclenet e5cba34
generatedby disambiguation inside dataset_description
bclenet a1ed69b
generatedby disambiguation inside dataset_description
bclenet 5d88b84
Context update
bclenet dbe83a1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] e8fb8f5
Context update
bclenet 2c85671
GeneratedBy issues
bclenet e402c44
Minimal examples
bclenet 2b07187
Minimal example descriptions
bclenet 0784169
Update src/schema/objects/metadata.yaml
bclenet 4e7eb78
Update src/schema/objects/metadata.yaml
bclenet 053eb05
Update src/modality-agnostic-files/provenance.md
bclenet 96b7f98
Ids for provEntities
bclenet d909b25
Consistency of metadata fields description
bclenet ea35719
RDF section
bclenet 038b447
RDF section
bclenet c2e19da
Study dataset minimal example
bclenet 98e0388
Codespell
bclenet e63f230
Possibility to set Command metadata to null for manual activities
bclenet c65798a
shorten example text and link to the BIDS website
cmaumet 275ce3a
Note as text instead of a box (this info is more of some additional i…
cmaumet d2a7c31
condense the intro
cmaumet ee10fb5
link to subsection RDF
cmaumet e35a9d0
removing heading as per https://github.com/bids-standard/bids-specifi…
cmaumet cfb3b6b
text formatting + remove mention of metadata fields
cmaumet 3923b62
use extension rather than 'one or more'
cmaumet 0688c39
fix typo
cmaumet 6c88f9f
JSON null as type
bclenet dd3a9a7
Update link to examples
cmaumet 4c1d29b
Update metadata fields info
cmaumet 0195d94
Merge pull request #1 from cmaumet/BEP028_spec
bclenet ee05c7e
provenance.tsv rules
bclenet 2d7bee5
Activity/activities
bclenet dbf090f
Provenance page reorganize
bclenet 34f12eb
Merge branch 'master' into BEP028_spec
bclenet f68ff09
Moving provenance graph to RDF section
bclenet 936dc23
Provemance context adress
bclenet cce17f2
Rephrase intros for sections Provenance of...
bclenet ac0bb48
Removing notion of provenance objects
bclenet 4705139
Removing notion of provenance objects
bclenet 42754ab
Removing notion of provenance objects
bclenet edfb21e
Rules for provenance.tsv
bclenet f40eeec
Merge branch 'master' into BEP028_spec
bclenet 7b4c8f0
fix link
cmaumet 520d593
Update src/modality-agnostic-files/provenance.md
cmaumet 7cd617e
Update src/schema/objects/metadata.yaml
bclenet 08560e9
Consistency of identifiers
bclenet 4a13c31
cmaumet review
bclenet c32f61d
ProvEntities are files
bclenet b6e5367
Identifier for
bclenet 9aa83df
Description for Type
bclenet c106bb8
Trying to remove occurences of provEntity
bclenet b7d5d38
More precise descriptions for suffixes
bclenet 45f6d40
yamllint
bclenet 1659f3e
Back to provenance Type having its own metadata
bclenet f2a8e56
Files and Datasets as terms
bclenet eb77bb1
Removing ProvEntities
bclenet c252b42
Optional subdirectories under prov/
bclenet 0af878d
Rule for all sidecars to contain provenance fields
bclenet 81cec52
dataset_description generatedby
bclenet 51b5175
yamlint
bclenet 0a5f13f
Selectors
bclenet 5c5e7dd
Selectors
bclenet c8c0427
Selectors
bclenet 0525b50
Selectors
bclenet ac2fb74
Add empty line after amonition block declaration
bclenet 6caa905
Merge branch 'master' into BEP028_spec
bclenet 7360d88
Add empty line after amonition block declaration
bclenet b1f13bb
Double_ in metadata name for dataset generatedby
bclenet 99e9c10
refactor metadata fields
bclenet 49d91bf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] d200858
refactor metadata fields
bclenet 6cebc04
refactor metadata fields
bclenet bab2c81
refactor metadata fields
bclenet 8ed505b
Merge branch 'master' into BEP028_spec
bclenet 6e16f90
omit 'section' for internal links
cmaumet f168c66
rephrase intro
cmaumet e9e27cd
link to ex
cmaumet a923e45
text shortening
cmaumet d85f7c8
shorten description generatedby for datasets
cmaumet e8de6bb
text link to ex
cmaumet 4290c56
remove tool mention act
cmaumet 7a90b42
change all snipped to for a complete ex
cmaumet 75849bd
RRID or other alternative id
cmaumet 6d2b8f5
acted on behalf desc
cmaumet 1f7a1bd
provEntity sentance
bclenet ff930ea
Merge branch 'master' into BEP028_spec
bclenet 7398ccb
Merge pull request #2 from cmaumet/BEP028_spec
bclenet 09610b4
Other comments from Camille
bclenet 01d7fcf
Removing desc entity for provenance files
bclenet 620e755
Consistncy with SPM example
bclenet 8bc2924
Entities -> prov:Entity
bclenet ee5a1d4
Entities -> prov:Entity
bclenet a357b6d
prov:Entities -> prov:Entity
bclenet e742529
URI consitency with examples
bclenet ef1d34d
Review from Yarik and Camille
bclenet 143647d
NIfTI
bclenet 229c2eb
Description for activities
bclenet 3c8f902
Description for activities
bclenet 8acf0e4
Schema update
bclenet 59d8c79
Update spec with manual example
bclenet 2195048
altidentifier as a list
bclenet 4e0d993
provenance_label > provenance_id
bclenet 5923671
provenance_id
bclenet 7ecd53c
All PROV-O Starting Point Terms in context
bclenet 067b792
Merge branch 'master' into BEP028_spec
bclenet 4f0a451
External file description not needed
bclenet 6b88a10
Satra review
bclenet 6597b74
Merge branch 'bids-standard:master' into BEP028_spec
bclenet 08f8e5c
Example names
bclenet eefb1b0
Review from Ross and Chris
bclenet c608e9b
Review from Ross and Chris, part 2
bclenet 1cba830
Review from Ross and Chris, part 3
bclenet c10a808
Review from Ross and Chris, part 4
bclenet d20ea03
Sembr / soft rules
bclenet 2a1421c
entity prov -> provenance
bclenet 983f4bf
Merge branch 'master' into BEP028_spec
bclenet 5e54417
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] d3737a8
remark
bclenet 6e1ee4d
schema provenance entity
bclenet 24377af
Apply suggestions from code review
effigies 27a826e
Update src/schema/rules/json/prov.yaml
effigies 63bf531
chore(deps): bump prettier in the node-utilities group (#2334)
dependabot[bot] 9b3b0da
BIDS compliant RDF graph
bclenet 93f1115
Check provenance.tsv is inside prov/
bclenet 77f0a5d
Correspondances with WC3 prov
bclenet 6cffae2
AlternativeIdentifier
bclenet df460dc
type: array yaml errors
bclenet 792be4a
yamlint
bclenet 33e823b
Correspondances for Type
bclenet 2a5c98a
Digest for Environments
bclenet 2550cc6
Id correspondance
bclenet 63bef3d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 225c2f8
JSON in markdown
bclenet 23a2af4
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 6026578
Id correspondance
bclenet e719615
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] be88db7
yamlint
bclenet ef8bafe
AtLocation correspondance
bclenet cad1280
rdf:type instead of json-ld:@type
bclenet 3a1f480
Rm digets and type for dataset
bclenet 622aa49
Rm Digest and Type for Dataset
bclenet 0f33757
Use of Type in RDF section
bclenet 0dff4f3
Use of Type in RDF section
bclenet 64e9134
Environment example
bclenet 93c5b54
Citing BIDS-Prov
bclenet 8d314d3
Camille review
bclenet c1acdde
Camille review
bclenet e84785e
Camille review
bclenet 9b88a0e
Provenance identifiers & provenance graph
bclenet e88b235
Identifier(s) links to Provenance identifiers section
bclenet 6e12ee7
Activities.Description is an extended description
bclenet 68f77ac
Activities.Description -> rdfs:comment
bclenet 839f63a
Clarification note about Id and Label
bclenet 1e1a9ca
yamlint
bclenet 0217270
have subprov use full entity keyname 'provenance' to allow proper loo…
rwblair 9a6cac5
Digest -> Checksum using controlled terms
bclenet 3f3cd9d
Alternative identifier for ChecksumAlgorithm
bclenet ccf0d69
Alternative identifier for ChecksumAlgorithm
bclenet 4e16feb
Typos in provenance.md
bclenet f1f0e53
io suffix instead of ent
bclenet 3703af9
Typo in provenance context
bclenet 65e16cb
ChecksumAlgorithm and Value in metadata
bclenet 5256a2a
Typo in metadata
bclenet 7b4fec5
More examples for ChecksumAlgorithm
bclenet aa4e409
Store provenance of any file in sidecar when possible
bclenet 61dd4c4
may in uppercase
bclenet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm assuming this is just to demonstrate an arbitrary fragment. My experience with BIDS is that people see an example and interpret it as a directive, so I would not include this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not against removing this example, but do you think it would be clearer if we explain what this id is intended for ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree. I was reviewing the BEP and wondered if there is a cosmetically better way to generate example
<uid>.