From df208a7ad7073f5720454e2980b951136f7b229d Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Tue, 26 May 2020 22:17:06 +0200 Subject: [PATCH 1/2] ENH: optionally allow LICENSE file --- src/03-modality-agnostic-files.md | 38 +++++++++++++++++++------------ 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/src/03-modality-agnostic-files.md b/src/03-modality-agnostic-files.md index 69afd71ea2..b2837bf11a 100644 --- a/src/03-modality-agnostic-files.md +++ b/src/03-modality-agnostic-files.md @@ -7,24 +7,25 @@ Templates: - `dataset_description.json` - `README` - `CHANGES` +- `LICENSE` ### `dataset_description.json` -The file dataset_description.json is a JSON file describing the dataset. Every -dataset MUST include this file with the following fields: +The file `dataset_description.json` is a JSON file describing the dataset. +Every dataset MUST include this file with the following fields: -| Field name | Definition | +| Field name | Definition | | ------------------------------------------------------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Name | REQUIRED. Name of the dataset. | -| BIDSVersion | REQUIRED. The version of the BIDS standard that was used. | -| License | RECOMMENDED. What license is this dataset distributed under? The use of license name abbreviations is suggested for specifying a license. A list of common licenses with suggested abbreviations can be found in Appendix II. | -| Authors | OPTIONAL. List of individuals who contributed to the creation/curation of the dataset. | -| Acknowledgements | OPTIONAL. Text acknowledging contributions of individuals or institutions beyond those listed in Authors or Funding. | -| HowToAcknowledge | OPTIONAL. Text containing instructions on how researchers using this dataset should acknowledge the original authors. This field can also be used to define a publication that should be cited in publications that use the dataset. | -| Funding | OPTIONAL. List of sources of funding (grant numbers). | -| EthicsApprovals | OPTIONAL. List of ethics committee approvals of the research protocols and/or protocol identifiers. | | -| ReferencesAndLinks | OPTIONAL. List of references to publication that contain information on the dataset, or links. | -| DatasetDOI | OPTIONAL. The Document Object Identifier of the dataset (not the corresponding paper). | +| Name | REQUIRED. Name of the dataset. | +| BIDSVersion | REQUIRED. The version of the BIDS standard that was used. | +| License | RECOMMENDED. The license for the dataset. The use of license name abbreviations is RECOMMENDED for specifying a license (see [Appendix 2](./99-appendices/02-licenses.md). The corresponding full license text MAY be specified in an additional `LICENSE` file. | +| Authors | OPTIONAL. List of individuals who contributed to the creation/curation of the dataset. | +| Acknowledgements | OPTIONAL. Text acknowledging contributions of individuals or institutions beyond those listed in Authors or Funding. | +| HowToAcknowledge | OPTIONAL. Text containing instructions on how researchers using this dataset should acknowledge the original authors. This field can also be used to define a publication that should be cited in publications that use the dataset. | +| Funding | OPTIONAL. List of sources of funding (grant numbers). | +| EthicsApprovals | OPTIONAL. List of ethics committee approvals of the research protocols and/or protocol identifiers. | +| ReferencesAndLinks | OPTIONAL. List of references to publication that contain information on the dataset, or links. | +| DatasetDOI | OPTIONAL. The Document Object Identifier of the dataset (not the corresponding paper). | Example: @@ -57,8 +58,8 @@ Example: ### `README` In addition a free form text file (`README`) describing the dataset in more -details SHOULD be provided. The `README` file MUST be either in ASCII or UTF-8 -encoding. +details SHOULD be provided. +The `README` file MUST be either in ASCII or UTF-8 encoding. ### `CHANGES` @@ -78,6 +79,13 @@ Example: - Initial release. ``` +### `LICENSE` + +A `LICENSE` file MAY be provided in addition to the short specification of the +used license in the `dataset_description.json` `"License"` field. +The `"License"` field and `LICENSE` file MUST correspond. +The `LICENSE` file MUST be either in ASCII or UTF-8 encoding. + ## Participants file Template: From 7e5551f2a6d123952ee7f5275ec317b204a3aeb1 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Wed, 27 May 2020 12:11:52 +0200 Subject: [PATCH 2/2] 2 -> II Co-authored-by: Chris Markiewicz --- src/03-modality-agnostic-files.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/03-modality-agnostic-files.md b/src/03-modality-agnostic-files.md index b2837bf11a..9c711f18fc 100644 --- a/src/03-modality-agnostic-files.md +++ b/src/03-modality-agnostic-files.md @@ -14,18 +14,18 @@ Templates: The file `dataset_description.json` is a JSON file describing the dataset. Every dataset MUST include this file with the following fields: -| Field name | Definition | +| Field name | Definition | | ------------------------------------------------------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Name | REQUIRED. Name of the dataset. | -| BIDSVersion | REQUIRED. The version of the BIDS standard that was used. | -| License | RECOMMENDED. The license for the dataset. The use of license name abbreviations is RECOMMENDED for specifying a license (see [Appendix 2](./99-appendices/02-licenses.md). The corresponding full license text MAY be specified in an additional `LICENSE` file. | -| Authors | OPTIONAL. List of individuals who contributed to the creation/curation of the dataset. | -| Acknowledgements | OPTIONAL. Text acknowledging contributions of individuals or institutions beyond those listed in Authors or Funding. | -| HowToAcknowledge | OPTIONAL. Text containing instructions on how researchers using this dataset should acknowledge the original authors. This field can also be used to define a publication that should be cited in publications that use the dataset. | -| Funding | OPTIONAL. List of sources of funding (grant numbers). | -| EthicsApprovals | OPTIONAL. List of ethics committee approvals of the research protocols and/or protocol identifiers. | -| ReferencesAndLinks | OPTIONAL. List of references to publication that contain information on the dataset, or links. | -| DatasetDOI | OPTIONAL. The Document Object Identifier of the dataset (not the corresponding paper). | +| Name | REQUIRED. Name of the dataset. | +| BIDSVersion | REQUIRED. The version of the BIDS standard that was used. | +| License | RECOMMENDED. The license for the dataset. The use of license name abbreviations is RECOMMENDED for specifying a license (see [Appendix II](./99-appendices/02-licenses.md)). The corresponding full license text MAY be specified in an additional `LICENSE` file. | +| Authors | OPTIONAL. List of individuals who contributed to the creation/curation of the dataset. | +| Acknowledgements | OPTIONAL. Text acknowledging contributions of individuals or institutions beyond those listed in Authors or Funding. | +| HowToAcknowledge | OPTIONAL. Text containing instructions on how researchers using this dataset should acknowledge the original authors. This field can also be used to define a publication that should be cited in publications that use the dataset. | +| Funding | OPTIONAL. List of sources of funding (grant numbers). | +| EthicsApprovals | OPTIONAL. List of ethics committee approvals of the research protocols and/or protocol identifiers. | +| ReferencesAndLinks | OPTIONAL. List of references to publication that contain information on the dataset, or links. | +| DatasetDOI | OPTIONAL. The Document Object Identifier of the dataset (not the corresponding paper). | Example: