diff --git a/external/integrity/naming/file_naming.md b/external/integrity/naming/file_naming.md index 878ea253f6a3bd429b3528aff2a47eb98b9f02dc..a1cda6cbccea51248dd8cdd26a917975f47ab8d4 100644 --- a/external/integrity/naming/file_naming.md +++ b/external/integrity/naming/file_naming.md @@ -16,6 +16,8 @@ Good file name follows three basic principles: * human readable * plays well with default ordering +If you are looking for information on how to organize and structure your folders, you may find this [dedicated card](https://howto.lcsb.uni.lu/?integrity:organization) helpful. + ## Machine readable Special characters can have different meaning for different operation system or software. The most commonly found are diff --git a/external/integrity/organization/LCSB_GRPNAME/_alumni/firstLast1/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/_alumni/firstLast1/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/_alumni/firstLast2/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/_alumni/firstLast2/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/grants/grant1/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/grants/grant1/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/grants/grant2/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/grants/grant2/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/_project0/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/_project0/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/analysis/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/analysis/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/figures/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/figures/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/manuscript/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/manuscript/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/rawData/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper1/rawData/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/analysis/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/analysis/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/figures/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/figures/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/manuscript/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/manuscript/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/rawData/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/papers/paper2/rawData/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/posters/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/posters/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/presentations/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project1/presentations/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program1/project2/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program1/project2/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/programs/program2/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/programs/program2/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/resources/courses/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/resources/courses/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/resources/hardware/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/resources/hardware/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/resources/literature/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/resources/literature/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/resources/personnel/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/resources/personnel/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/resources/software/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/resources/software/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/students/firstLast1/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/students/firstLast1/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/students/firstLast2/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/students/firstLast2/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/team/achievements/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/team/achievements/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/LCSB_GRPNAME/team/meetingNotes/.gitkeep b/external/integrity/organization/LCSB_GRPNAME/team/meetingNotes/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/external/integrity/organization/organization.md b/external/integrity/organization/organization.md new file mode 100644 index 0000000000000000000000000000000000000000..ff4f1f963edee94b71b94cc2eb0eec814aa6b14e --- /dev/null +++ b/external/integrity/organization/organization.md @@ -0,0 +1,104 @@ +--- +layout: page +permalink: /external/integrity/organization/ +shortcut: integrity:organization +redirect_from: + - /cards/integrity:organization + - /external/cards/integrity:organization +--- + +# Organization + +## Process of organizing files and folders + +The present suggestions are to guide individual researchers and staff members. It is important to note that certain research groups already have specific group guidelines in place. + +## Structure of folders + +Organizing files in directories is a key task to stay organized and to make sure that everyone is +able to find back the files easily. + +A key rule is to name the folders with straightforward but explicit names, and to include the decision tree of where to put a given file inside the folder structure. In fact, the directory tree should in some sense +reflect the decision tree. + +More details on naming files and folders are provided in the dedicated [file naming card](https://howto.lcsb.uni.lu/?integrity:naming). + +## Suggestions + +There are a few suggestions to organize a folder structure: + +### Suggestion 1 +Only have a few folders per level (i.e. 5-6 folders per level). That way, the decision of where to include a file is straightforward. + +### Suggestion 2 +The more general the upper levels and the more precise the lower levels are, the easier it is for someone to decide where to include a respective file. The idea is to mirror a real tree. + +### Suggestion 3 +Depending on the setup of the research group, it might be useful to structure the group's overall mission into separate programs, sub-missions, or areas of expertise. + +### Suggestion 4 +Archived folders (or frozen folders) can be named with an `_` (underscore) preceding the actual name of the folder. + +## Example + +An example for a folder of research group at LCSB: + +``` +LCSB_GRPNAME +├── _alumni +│ ├── firstLast1 +│ └── firstLast2 +├── grants +│ ├── grant1 +│ └── grant2 +├── programs +│ ├── program1 +│ │ ├── _project0 +│ │ ├── project1 +│ │ │ ├── papers +│ │ │ │ ├── paper1 +│ │ │ │ │ ├── analysis +│ │ │ │ │ ├── figures +│ │ │ │ │ ├── manuscript +│ │ │ │ │ └── rawData +│ │ │ │ └── paper2 +│ │ │ │ ├── analysis +│ │ │ │ ├── figures +│ │ │ │ ├── manuscript +│ │ │ │ └── rawData +│ │ │ ├── posters +│ │ │ └── presentations +│ │ └── project2 +│ └── program2 +├── resources +│ ├── courses +│ ├── hardware +│ ├── literature +│ ├── personnel +│ └── software +├── students +│ ├── firstLast1 +│ └── firstLast2 +└── team + ├── achievements + └── meetingNotes +``` + +## Specific guidelines for raw data + +In the `rawData` folder, of each paper, you should include +* Links to data +* Links to lab books (Paper) +* PDF of book if ELN + +When using data collection platforms, make sure that you follow their specific guidelines. Avoid the use of personal folders for raw data storage. + +Generally, the following is often the case depending on the type of data: + +* **Common data**: Export raw data where possible and store it on one of the storage locations defined above or as defined in the group guidelines. +* **Group specific data**: Export raw data where possible and store it on one of the storage locations defined above or as defined in the group guidelines. Make sure all raw data is properly backed up. +* **Platform specific data**: Export or retrieve raw data where possible and store it on one of the storage locations defined defined above, as defined in the group guidelines, or as defined in the platform-specific guidelines. No backups will be provided by the platform. + +## Specific guidelines for ELN + +In general, make sure that all lab books (paper and electronic versions) exist and are available to somebody from the group. By default, all ELN should be readable by the group. diff --git a/index.md b/index.md index cafc03b5664b1d6f46f053c9c7fd46cda6225cde..e656f6a8c8bc89a47da977c7c3417806f6048f00 100644 --- a/index.md +++ b/index.md @@ -58,6 +58,7 @@ The How-to cards are intended to provide practical guidance in implementing Data <li><a href="external/integrity/encryption/disk">Encrypting the Startup Disk for Your Laptop/Desktop</a></li> <li><a href="external/integrity/encryption/file">Encrypting Files and Folders</a></li> <li><a href="external/integrity/naming">Naming files</a></li> + <li><a href="external/integrity/organization">Organization of folders</a></li> </ul> </div>