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

Addition of method to filter features based on quality assessment #713

Merged
merged 16 commits into from
Feb 1, 2024

Conversation

philouail
Copy link
Collaborator

Here is the implementation of the filterFeatures function with different quality assessment methods. I also wrote the method so that they can handle both XcmsResult objects and SummarisedExperiment objects.

@jorainer I have updated the PercentMissingFilter so that now it filters based on the different sample types using factor.

I tried to make the documentation comprehensive but don't hesitate to tell me if something is not clear or not explained in enough details for the users.

These different classes/methods are based on the quality assessment function from MetaboCoreUtils. So some information can also be found in this package.

Thanks in advance for the feedback !

@philouail philouail marked this pull request as draft January 25, 2024 07:53
@philouail philouail marked this pull request as ready for review January 25, 2024 10:28
Copy link
Collaborator

@jorainer jorainer left a comment

Choose a reason for hiding this comment

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

Really great PR adding relevant functionality @philouail ! I have some change requests, but only minor ones.

DESCRIPTION Outdated Show resolved Hide resolved
R/method-filterFeatures.R Outdated Show resolved Hide resolved
R/method-filterFeatures.R Outdated Show resolved Hide resolved
R/method-filterFeatures.R Outdated Show resolved Hide resolved
R/method-filterFeatures.R Outdated Show resolved Hide resolved
vignettes/xcms.Rmd Outdated Show resolved Hide resolved
vignettes/xcms.Rmd Outdated Show resolved Hide resolved
vignettes/xcms.Rmd Show resolved Hide resolved
vignettes/xcms.Rmd Outdated Show resolved Hide resolved
vignettes/xcms.Rmd Outdated Show resolved Hide resolved
#' ## Set up parameter to flag possible contaminant based on blank samples
#' filter <- BlankFlag(
#' qcIndex = sampleData(test_xcms)$sample_type == "QC",
#' blankIndex = sampleData(test_xcms)$sample_type == "study")
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

here i'm not sure what to do, I think it might be confusing for people that i use study samples as blank samples(because the object does not have blanks). I can explain it but is it a good idea ?
Otherwise should I had like 2 randomly generated blank sample to the object and use that as an example ?

@philouail philouail marked this pull request as draft January 26, 2024 19:24
Copy link
Collaborator

@jorainer jorainer left a comment

Choose a reason for hiding this comment

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

Great contribution @philouail ! I have only very minor things/typos left. After that I would be OK for merging - given @sneumann agrees.

DESCRIPTION Show resolved Hide resolved
vignettes/xcms.Rmd Outdated Show resolved Hide resolved
R/method-filterFeatures.R Outdated Show resolved Hide resolved
R/method-filterFeatures.R Show resolved Hide resolved
R/method-filterFeatures.R Outdated Show resolved Hide resolved
@philouail philouail marked this pull request as ready for review January 29, 2024 14:57
Copy link
Owner

@sneumann sneumann left a comment

Choose a reason for hiding this comment

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

Hi, thanks a lot, nothing to add ! Yours, Steffen

@sneumann sneumann merged commit 1cf7cda into devel Feb 1, 2024
2 of 3 checks passed
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