Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hit selection module #191

Merged
merged 22 commits into from
Sep 4, 2024
Merged

hit selection module #191

merged 22 commits into from
Sep 4, 2024

Conversation

LaurenceKuhl
Copy link
Contributor

@LaurenceKuhl LaurenceKuhl commented Aug 16, 2024

This PR aims to add a new feature : hit selection. The aim would be to run an algorithm on found gene essentials and determine a p-value cutoff based on the degree of protein protein interaction network.

nf-core/crisprseq runs MAGeCK RRA, MAGeCK MLE, BAGEL2 or DRUGZ so I've plugged HITSELECTION after each of these processes and added a parameter giving the user the option to run hitselection or not.

It bases itself on an R script in the module hitselection.nf and on 2 assets : hgnc_complete_set and biogrid_hgncid

Copy link

github-actions bot commented Aug 16, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 98d683e

+| ✅ 229 tests passed       |+
#| ❔   3 tests were ignored |#
!| ❗   4 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline

❔ Tests ignored:

  • files_exist - File is ignored: conf/test.config
  • files_exist - File is ignored: conf/test_full.config
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-09-04 13:06:44

docs/output/screening.md Outdated Show resolved Hide resolved
@LaurenceKuhl LaurenceKuhl changed the title hit selection first draft hit selection module Sep 2, 2024
docs/usage/screening.md Outdated Show resolved Hide resolved
Copy link
Contributor

@WackerO WackerO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some small remarks, looks otherwise good so I'll directly approve :)


min <- 0
max <- ${hit_selection_iteration_nb}
steps <- max - min
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If min is always 0, this is not really necessary

steps <- max - min
hit.genes.last <- NULL
final_results <- list() # Initialize as an empty list
for(i in 1:steps) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can accordingly be changed as well

docs/usage/screening.md Outdated Show resolved Hide resolved
docs/usage/screening.md Outdated Show resolved Hide resolved
@LaurenceKuhl LaurenceKuhl merged commit 5f241de into nf-core:dev Sep 4, 2024
14 checks passed
Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! I know this PR is already merged but I am leaving a couple of comments which I think should be fixed in the docs 🙂

- ([MAGeCK test](https://sourceforge.net/p/mageck/wiki/usage/#test))
- ([MAGeCK mle](https://sourceforge.net/p/mageck/wiki/Home/#mle))
- ([BAGEL2](https://github.com/hart-lab/bagel))
- ([DrugZ](https://github.com/hart-lab/drugz))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this go under point 5?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually no it's also a gene essentiality analysis but only on drug treated cell lines. It does something similar to MAGeCK MLE

Comment on lines +145 to +147
## :warning: The hitselection algorithm is for the moment developed only for KO screens and requires the library to map to genes with an Homosapiens EntrezID.

## :warning: Please be advised that the Hitselection algorithm is time intensive and will make the pipeline run longer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To show a formatted warning box on the webside the notation is the following:

> [!WARNING]
> The hitselection algorithm is for the moment developed only for KO screens and requires the library to map to genes with an Homosapiens EntrezID.

> [!WARNING]
Please be advised that the Hitselection algorithm is time intensive and will make the pipeline run longer

@LaurenceKuhl LaurenceKuhl mentioned this pull request Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants