Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
philouail committed Jan 26, 2024
1 parent 9a0410b commit a025fc1
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 7 deletions.
2 changes: 0 additions & 2 deletions R/method-filterFeatures.R
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@
#'
#' ## Load a test data set with features defined.
#' test_xcms <- loadXcmsData()
#'
#' ## Set up parameter to filter based on coefficient of variation. By setting
#' ## the filter such as below, features that have a coefficient of variation
#' ## superior to 0.3 in QC samples will be removed from the object `test_xcms`
Expand All @@ -88,7 +87,6 @@
#'
#' filtered_data_rsd <- filterFeatures(object = test_xcms, filter = rsd_filter)
#'
#'
#' ## Set up parameter to filter based on D-ratio. By setting the filter such
#' ## as below, features that have a D-ratio computed based on their abundance
#' ## between QC and study samples superior to 0.5 will be removed from the
Expand Down
4 changes: 1 addition & 3 deletions man/filterFeatures.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions vignettes/xcms.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -1124,12 +1124,12 @@ The `filter` argument can accommodate various types of input, each determining t
specific type of quality assessment and filtering to be performed.

The `RsdFilter` enable users to filter features based on their relative
standard deviation (coefficient of vairation) for a specified `threshold`. It
standard deviation (coefficient of variation) for a specified `threshold`. It
is recommended to base the computation on quality control (QC) samples,
as demonstrated below:

```{r}
# Set up parameters for RsdFilter
# Set up parameters for RsdFilter
rsd_filter <- RsdFilter(threshold = 0.3,
qcIndex = sampleData(faahko)$sample_type == "QC")
Expand Down

0 comments on commit a025fc1

Please sign in to comment.