Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 21 additions & 18 deletions docs/BBGProtocols/BBGlab_new_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,49 @@

## Create project folders in the cluster

Check the cluster structure organization
[here](https://bbglab.github.io/bbgwiki/Cluster_basics/Structure/#description).
You can create the corresponding project folders within main directories:
Check the cluster structure organization [here](https://bbglab.github.io/bbgwiki/Cluster_basics/Structure/#description).
You can create the corresponding project folders within these main directories:

- Create **project folder** in `/data/bbg/projects/`.
This folder should contain all the files related to the analysis of your project
(jupyter notebooks, scripts, processed files, etc.)
- Create **dataset folder** in `/data/bbg/datasets/` or `/data/bbg/datasafe/` or s3.
This folder should contain all the original data (or mildly processed data) of your project
(fastq files, bam files, vcf files, maf files, etc.).

To create these folders in the cluster, follow [these instrucions](https://bbglab.github.io/bbgwiki/Cluster_basics/NewFolders/).

Check failure on line 17 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:17:121 MD013/line-length Line length [Expected: 120; Actual: 128] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 17 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:17:121 MD013/line-length Line length [Expected: 120; Actual: 128] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Remember to add the dataset to the **BBG Datasets spreadsheet**, either if it is external
(downloaded from a repository, from a collaborator) or internal (in house sequenced).
Please find further information about the BBG Datasets
[here](https://bbglab.github.io/bbgwiki/Datasets/Datasets_BBGLAB/).
Find further information about the BBG Datasets [here](https://bbglab.github.io/bbgwiki/Datasets/Datasets_BBGLAB/).


To create these folders, follow
[these instrucions](https://bbglab.github.io/bbgwiki/Cluster_basics/NewFolders/).

## Properly organize your project folder

Check failure on line 25 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:25:121 MD013/line-length Line length [Expected: 120; Actual: 163] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 25 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:25:121 MD013/line-length Line length [Expected: 120; Actual: 163] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Remember to follow the
[BBGlab best practices](https://bbglab.github.io/bbgwiki/BBGProtocols/BBglab_data_organization/).
when organizing your project directory.
In addition, you should create a copy of the **Project Compilation spreadsheet** with your name,
fill it up with the information of your project/s and keep updating it whenever needed.
Please find the Project Compilation files
[here](https://drive.google.com/drive/u/0/folders/1vGfO8B-vU-QRRf4ho4B5_Tnfe4neS7Y9).
Remember to follow the **[BBGlab best practices](https://bbglab.github.io/bbgwiki/BBGProtocols/BBglab_data_organization/)** when organizing your project directory.

Check failure on line 27 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:27:121 MD013/line-length Line length [Expected: 120; Actual: 179] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 27 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:27:121 MD013/line-length Line length [Expected: 120; Actual: 179] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Additionally, you should fill the **Project Compilation spreadsheet** that indicates all the paths in the cluster that you have been working in across all your projects. For that:

Check failure on line 29 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:29:121 MD013/line-length Line length [Expected: 120; Actual: 160] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 29 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:29:121 MD013/line-length Line length [Expected: 120; Actual: 160] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

1. Create a copy of the **[Project Compilation template](https://docs.google.com/spreadsheets/d/1jJleTek9eP4S6CCe5fO8_M4-vLuKhumgKjlQ58jP_rc/edit?gid=0#gid=0)**
2. Change the name of the document with your information as follow:

Check failure on line 32 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:32:121 MD013/line-length Line length [Expected: 120; Actual: 121] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 32 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:32:121 MD013/line-length Line length [Expected: 120; Actual: 121] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md
`ProjectCompilation-202X-NameSurename`
3. Store it in your Google drive folder (to be updated once the bbglab shared drive is available to store it accordingly)
4. Modify the document by removing the rows showing the examples, and adding our own entries.

Check failure on line 35 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:35:121 MD013/line-length Line length [Expected: 120; Actual: 269] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 35 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:35:121 MD013/line-length Line length [Expected: 120; Actual: 269] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Remember to keep updating the file regularly so that information is available for everyone at any time. Note that this file will be needed once you do the **[BBGlab Exit Protocol](https://drive.google.com/file/d/1BnhLZCygroJ-dfamuZw8YvDgndIFmzzP/view?usp=drive_link)**.

## Properly organize your google drive

Check failure on line 39 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:39:121 MD013/line-length Line length [Expected: 120; Actual: 130] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 39 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:39:121 MD013/line-length Line length [Expected: 120; Actual: 130] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

You can also follow the
[BBGlab best practices](https://bbglab.github.io/bbgwiki/BBGProtocols/BBglab_data_organization/) for that.
You can also follow the [BBGlab best practices](https://bbglab.github.io/bbgwiki/BBGProtocols/BBglab_data_organization/) for that.

## Track changes in Git

Check failure on line 44 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:44:121 MD013/line-length Line length [Expected: 120; Actual: 143] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

Check failure on line 44 in docs/BBGProtocols/BBGlab_new_protocol.md

View workflow job for this annotation

GitHub Actions / Lint Markdown Files

Line length

docs/BBGProtocols/BBGlab_new_protocol.md:44:121 MD013/line-length Line length [Expected: 120; Actual: 143] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md
You should have a Github account to track all your code in terms of version control and collaboration.
You can create a github account if you don't have one yet. Check the
[Git guidelines](https://bbglab.github.io/bbgwiki/Tools/Programming/git/).
You can create a github account if you don't have one yet. Check the [Git guidelines](https://bbglab.github.io/bbgwiki/Tools/Programming/git/).

## Reference

- Elisabet Figuerola
- Ferriol Calvet
- Mònica Sánchez
Loading