diff --git a/CITATION.cff b/CITATION.cff index d29de77..6efcd20 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,6 +2,9 @@ cff-version: 1.2.0 message: "If you use this code, please cite the associated article and this software release." title: "Analysis code for gabapentinoid prescribing in Catalonia" type: software +repository-code: "https://github.com/DS3-SISCAT/Gabapentinoids" +url: "https://github.com/DS3-SISCAT/Gabapentinoids" +license: MIT authors: - family-names: "de Pando" given-names: "Thais" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b21910c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 DS3-SISCAT and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/LICENSE-CONTENT.md b/LICENSE-CONTENT.md new file mode 100644 index 0000000..c8f7bef --- /dev/null +++ b/LICENSE-CONTENT.md @@ -0,0 +1,17 @@ +# License for documentation and public materials + +Except where otherwise stated, the documentation and non-software public materials in this repository are licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). + +This applies to: + +- Markdown documentation in the repository root and under `docs/`, `data/`, `outputs/`, `R/`, and `scripts/`; +- the public materials under `data/public/`; +- the diagnostic and regulatory mapping under `data/reference/`; +- the recorded environment metadata under `environment/`; and +- `CITATION.cff`. + +When reusing these materials, attribute **DS3-SISCAT and the study authors**, link to the CC BY 4.0 license, and indicate whether changes were made. The citation information in [`CITATION.cff`](CITATION.cff) provides the preferred scholarly attribution. + +Software code, scripts, workflows, and executable analysis logic are licensed separately under the [MIT License](LICENSE). + +Third-party material, if any, remains subject to its original terms. This license does not grant rights that DS3-SISCAT or the study authors do not hold. diff --git a/README.md b/README.md index e4a8876..9a44949 100644 --- a/README.md +++ b/README.md @@ -94,8 +94,10 @@ The first check rejects raw or processed data, checkpoints, patient-level filena The repository is designed to remain consistent with the manuscript statement that individual-level CatSalut data are subject to data-protection and governance restrictions and are not publicly available. The diagnostic code mapping is supplied as Supplementary Data File 1. See [DATA_AVAILABILITY.md](DATA_AVAILABILITY.md) for the operational interpretation. -## Citation and release status +## License and citation -Citation metadata are provided in [CITATION.cff](CITATION.cff). Replace the provisional software version with the final tag and add the article DOI after publication. +The software code, scripts, workflows, and executable analysis logic are licensed under the [MIT License](LICENSE). Documentation, the public supplement, the diagnostic/regulatory mapping, and other non-software public materials are licensed under [CC BY 4.0](LICENSE-CONTENT.md), except where otherwise stated. -This is a release candidate prepared for manuscript reproducibility. An institutional code licence has not yet been selected; complete [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md) before making the repository public. +Citation metadata are provided in [CITATION.cff](CITATION.cff). The software version and article DOI should be updated when the final article citation is available. + +The remaining publication and versioning tasks are recorded in [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md). diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md index d4abe93..f0b8e01 100644 --- a/RELEASE_CHECKLIST.md +++ b/RELEASE_CHECKLIST.md @@ -1,15 +1,15 @@ # Public release checklist -- [ ] Confirm the final GitHub owner, repository name, and public/private visibility. -- [ ] Obtain institutional confirmation that the analysis code and both mapping workbooks may be released. -- [ ] Select and add an institutionally approved software licence. +- [x] Confirm the final GitHub owner, repository name, and public visibility: `DS3-SISCAT/Gabapentinoids`. +- [x] Confirm release authority: publication authorised by the DS3 coordinator. +- [x] Add the selected licences: MIT for software and CC BY 4.0 for documentation and public non-software materials. - [ ] Confirm the final author list and citation metadata. - [ ] Add the article DOI and final journal citation when available. - [ ] State the formal route for requesting governed data access, if the data controller permits enquiries. -- [ ] Run `python tools/check_public_release.py` and resolve every finding. -- [ ] Run `Rscript tools/parse_all_code.R`. -- [ ] Review `git status` and verify that no generated file is staged. +- [x] Run `python tools/check_public_release.py` and resolve every finding. +- [x] Run `Rscript tools/parse_all_code.R`. +- [x] Review `git status` and verify that no generated file is staged. - [ ] Create a versioned release/tag matching the accepted manuscript. - [ ] Optionally archive the tagged release in a DOI-minting repository after acceptance. -Do not make the repository public until the licence and institutional release approval have been confirmed. +The repository may be made public after the completed items above have been verified for the release commit. The remaining unchecked items depend on article acceptance or final data-access wording and do not affect peer-review access to the current reproducibility materials.