Przeglądaj źródła

Template initialisation

julien colomb 1 rok temu
commit
63aa29b761

+ 1 - 0
.datalad/.gitattributes

@@ -0,0 +1 @@
+config annex.largefiles=nothing

+ 2 - 0
.datalad/config

@@ -0,0 +1,2 @@
+[datalad "dataset"]
+	id = 2b68d466-2b33-4776-ac2a-734ce365ec10

+ 63 - 0
.doc/information.md

@@ -0,0 +1,63 @@
+# How to use this template
+
+## Origin
+
+This project provides a template structure for research projects within the CRC/TRR 135 according to the results of a joint work with CRC 1158 and CRC 1315 (see <https://genr.eu/wp/towards-a-standardized-research-folder-structure/> for details).
+
+Check <https://github.com/tonic-team/Tonic-Research-Project-Template> if you want to use your own.
+
+## License
+
+By default, we added a CC-BY license to the repository, meaning anyone who can access this can reuse it anywhere, as long as he is mentioning the original work. You may want to delete it for now, and put it back (or another license) when you are ready to share this repository.
+
+## Easier Collaboration
+
+- Make sure every collaborator got to understand what files to find where.
+- This template was meant to be used in a git based workflow. This would allow you to collaborate using issues and pull requests.
+- The use of git submodule technology may help you share and publish only part of this repository. 
+
+Refer to XXX for further information.
+
+## Cheat sheet about what goes where:
+
+- Prior to data acquisition
+    - Save all documents related to research planning in the 01-Project_management folder, and update material and methods information as soon as possible.
+      For instance, indicate all information about reagents at the time of purchase.
+      And put any code or variable files created for data acquisition in the 02_material_methods folder.
+
+- Data acquisition and analysis
+    - Data is organised first following experiments, make sure to describe every experiment in a readme file and link to the adequate files saved in 02_material_methods.
+    - All files coming directly from your hardware should go in the rawdata folder.
+    - Any file that you want to archive or publish should go in the derivateddata folder. This includes results from manual analysis of the raw data.
+    - Any file created automatically during the analysis and that is easy to recreate should be saved in the processed_data folder: it will not be included in the long term storage or publication of the data.
+    - The 04_data_analysis folder should only include code and documentation of the analysis. If you are using excel to analyse the data, put the files in the processed_data and only add some text describing the analysis in the analysis folder. If you are using notebooks in python or R for analysis, their place is here.
+    - The output of your analysis (figures, and reproducible reports -pdfs-) should be saved in the 05_figures or the 06_disseminations/01_report_conferences/01_textreports folders, to facilitates sharing with non-coders.
+
+- Manuscript preparation
+    - Put figures ready for publication in the 05_figures/shared_figures folder.
+    - Put the manuscript (or some important versions of it, if using an external tool for writing it) in the 06_disseminations/02_manuscripts folder. You may want to use full URL to embed figures in the manuscript if the repository is open.
+
+
+
+## How to create a new study
+
+
+### Github
+
+Creating a new study project according to the tonic template is really easy: Just use the button `Use this template`, specify the owner, name and privacy and select button `Create repository from template`. Here we go!
+
+### GIN, GOGS
+
+Click the create new repository button on GIN, choose import repository and use `https://github.com/tonic-team/Tonic-Research-Project-Template` as the clone address
+
+### Tonic
+
+Yet to come !
+
+## Notes
+  
+We have some forks of this repository made for specific communities with additional information.
+
+# Changing folder name
+
+It is advised not to change folder names, so it is kept a standard. Also some implementation of this standard uses submodules, and changing folder name there might break the synchronisation work (one needs to use specific git command to change submodule path).

+ 3 - 0
.gitattributes

@@ -0,0 +1,3 @@
+* annex.backend=MD5E
+**/.git* annex.largefiles=nothing
+* annex.largefiles=((mimeencoding=binary)and(largerthan=0))

+ 21 - 0
.gitmodules

@@ -0,0 +1,21 @@
+
+[submodule "06_dissemination"]
+	path = 06_dissemination
+	url = ../template_02-06_dissemination
+	datalad-id = 8154943d-b846-4f00-a6e1-f22068209ac6
+[submodule "03_data/001_rawdata"]
+	path = 03_data/001_rawdata
+	url = ../template_02-03_data-001_rawdata
+	datalad-id = da576025-282b-48c4-8b43-353fcbbdd4e1
+[submodule "03_data/001_deriveddata"]
+	path = 03_data/001_deriveddata
+	url = ../template_02-03_data-001_deriveddata
+	datalad-id = 844a1ad4-224b-4b6d-a003-e97809c2724e
+[submodule "04_data_analysis/001_analysiscode"]
+	path = 04_data_analysis/001_analysiscode
+	url = ../template_02-04_data_analysis-001_analysiscode
+	datalad-id = 1787bebf-e3df-47e5-a242-8ba596979903
+[submodule "05_figures/990_shared_figures"]
+	path = 05_figures/990_shared_figures
+	url = ../template_02-05_figures-990_shared_figures
+	datalad-id = 7e63a757-b7dd-40b9-a91a-3b8ad0b54bde

+ 0 - 0
01_project_management/01_administration_files/.gitkeep


+ 0 - 0
01_project_management/02_accepted_grants/.gitkeep


+ 0 - 0
01_project_management/03_meeting_minutes/.gitkeep


+ 0 - 0
01_project_management/04_related_literature/.gitkeep


+ 0 - 0
01_project_management/05_data_management_plans/.gitkeep


+ 0 - 0
01_project_management/06_notebook/.gitkeep


+ 0 - 0
02_material_and_methods/01_protocols/.gitkeep


+ 0 - 0
02_material_and_methods/02_code/.gitkeep


+ 12 - 0
02_material_and_methods/README_MM.md

@@ -0,0 +1,12 @@
+# Content
+
+## Hardware details
+
+For self-built hardware, it is recommended to have a special repository for its description and link it with a URL or as a submodule here. For any hardware, you should provide a user guide with the following information:
+
+- How to check the hardware is working: calibration, validation
+- Troubleshooting guide, common issues
+- What was bought were?
+- What was custom-built, by whom and how ?
+- Critical hardware parts, what could be modified?
+- Schematics and/or photos (lots of photos)

+ 3 - 0
03_data/001_defaultexp/README.md

@@ -0,0 +1,3 @@
+# Content
+
+Please provide a summary of the content of this section and update it properly.

+ 1 - 0
03_data/001_deriveddata

@@ -0,0 +1 @@
+Subproject commit c8365472e087b6b3368d54a6169e73c40fdbc430

+ 1 - 0
03_data/001_rawdata

@@ -0,0 +1 @@
+Subproject commit 189bbbe66ba6b40ee004e2484c8d22cd54ccd15f

+ 0 - 0
03_data/999_processed_data/001_defaultexp_processed_data/.gitkeep


+ 26 - 0
03_data/README_DATA_STORE.md

@@ -0,0 +1,26 @@
+# Content
+
+This readme contains a summary of information you should provide about your data. This is mostly meant as a checklist, as the information should be best included in the readme of the data folders or in the data management plan. It is advised to draw the data flow to keep an overview.
+
+# 001
+
+## Hardware/tool used for acquisition
+
+## protocol
+
+- Standard procedure
+- Glossary/definition of terms (for categorical variables)
+- What changed, when and why
+- Techniques that were tested but not chosen, and why
+
+## raw data description
+
+- how does good/reliable data look like
+- exclusion criteria
+- data flow. What type of data is collected when
+- headers description, how to interpret the data
+
+## data analysis
+
+- analysis workflow
+- code versions

+ 1 - 0
04_data_analysis/001_analysiscode

@@ -0,0 +1 @@
+Subproject commit 4c50665344c8a476ffd48c2acd62c4392fe18999

+ 0 - 0
04_data_analysis/001_defaultexp_analysis/.gitkeep


+ 0 - 0
04_data_analysis/990_code_libraries/.gitkeep


+ 0 - 0
04_data_analysis/991_preregistration/.gitkeep


+ 3 - 0
04_data_analysis/README_DATA_ANALYSIS.md

@@ -0,0 +1,3 @@
+# Content
+
+Please provide a summary of the content of this section and update it properly.

+ 0 - 0
05_figures/001_defaultexp_figures/.gitkeep


+ 1 - 0
05_figures/990_shared_figures

@@ -0,0 +1 @@
+Subproject commit c90f7b350b5ca70d64f1386b861c274e2896bb8c

+ 3 - 0
05_figures/README_FIGURES.md

@@ -0,0 +1,3 @@
+# Content
+
+Please provide a summary of the content of this section and update it properly.

+ 1 - 0
06_dissemination

@@ -0,0 +1 @@
+Subproject commit 6ba27fd16c220f802d8e0e71dd6c93fafb57c253

+ 3 - 0
07_misc/README_MISC.md

@@ -0,0 +1,3 @@
+# Content
+
+Please provide a summary of the content of this section and update it properly.

+ 95 - 0
LICENSE-CC-BY

@@ -0,0 +1,95 @@
+Creative Commons Attribution 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+Section 1 – Definitions.
+
+    Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+    Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+    Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+    Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+    Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+    Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+    Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+    Licensor means the individual(s) or entity(ies) granting rights under this Public License.
+    Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+    Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+    You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+Section 2 – Scope.
+
+    License grant.
+        Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+            reproduce and Share the Licensed Material, in whole or in part; and
+            produce, reproduce, and Share Adapted Material.
+        Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+        Term. The term of this Public License is specified in Section 6(a).
+        Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+        Downstream recipients.
+            Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+            No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+        No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+
+    Other rights.
+        Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+        Patent and trademark rights are not licensed under this Public License.
+        To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+
+    Attribution.
+
+        If You Share the Licensed Material (including in modified form), You must:
+            retain the following if it is supplied by the Licensor with the Licensed Material:
+                identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+                a copyright notice;
+                a notice that refers to this Public License;
+                a notice that refers to the disclaimer of warranties;
+                a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+            indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+            indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+        You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+        If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+        If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
+
+Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+
+    for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+    if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
+    You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+    Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
+    To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
+
+    The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+Section 6 – Term and Termination.
+
+    This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+
+    Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+        automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+        upon express reinstatement by the Licensor.
+    For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+    For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+    Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+Section 7 – Other Terms and Conditions.
+
+    The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+    Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+Section 8 – Interpretation.
+
+    For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+    To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+    No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+    Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

+ 42 - 0
README.md

@@ -0,0 +1,42 @@
+# FIXME:Project title
+
+## Abstract, vision and goals
+
+## Project status
+
+### Roadmap and Milestones
+
+### Successes and failures
+
+## Contributors
+
+- jane doe, jane.doe@example.com, https://orcid.org/XXXX-XXXX-XXXX-XXXX, role:, responsibilities: , special skills
+
+[Mention your contributors either by including a contributors list here, or by referring to another file that lists your contributors, see documentation for options and examples. It is good practice to set roles for each contributor at the start of the project and discuss author byline of a future paper early.]
+
+## Experiments
+
+### 001
+
+FIX: short description, 
+details at [03_data/README_DATA_STORE](03_data/README_DATA_STORE)
+and/or in the data management plan: [01_project_management/05_data_management_plans](01_project_management/05_data_management_plans).
+
+## Communication
+
+- todo list: [use issues](../../issues)
+- minutes: [01_project_management/03_meeting_minutes](01_project_management/03_meeting_minutes)
+- Communication tools and email archive:
+
+## Outreach and external links
+
+- Smartfigure tag: [YOURTAG](https://sdash.sourcedata.io/?q=YOURTAG) [FIXME:replace YOURTAG in the url and the text.]
+
+
+## Contribution
+
+If you are new to this project, get familiar with the vision, set your own role and responsibilities with the team, and read the data management plan. Make sure your contributions can be understood and reused by other members of the team.
+
+## Technical note
+
+**Note:** This repository follows the Research repository template, v.2.4, see [further information offline](.doc/information.md) or [the online documentation page](https://gin-tonic.netlify.app/). Do not modify folder name unless you are sure of what you are doing.