Skip to content

Commit

Permalink
Fixed warnings during Rd. documentation generation on M$ Windows.
Browse files Browse the repository at this point in the history
  • Loading branch information
andzajan committed Jan 22, 2020
1 parent f4e4f61 commit de6b432
Show file tree
Hide file tree
Showing 18 changed files with 74 additions and 72 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: pmp
Type: Package
Title: Peak Matrix Processing and signal batch correction for metabolomics data sets
Version: 0.99.1
Version: 0.99.2
Author: Andris Jankevics and Ralf Weber
Maintainer: Andris Jankevics <[email protected]>
Description: Tools for scaling, normalisation and filtering of metabolomics data
Expand Down
6 changes: 3 additions & 3 deletions R/checkPeakMatrix.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ check_peak_matrix <- function(df, classes=NULL) {
}

#' If needed convert input data to object of class
#' \link[SummarizedExperiment]{SummarizedExperiment}
#' \link[SummarizedExperiment]{RangedSummarizedExperiment-class}
#'
#' @param df A matrix-like (e.g. an ordinary matrix, a data frame) object with
#' all values of class \code{numeric()} or \code{integer()} of peak
#' intensities, areas or other quantitative characteristic.
#' @param classes \code{character()}, vector of class labels. Must be the same
#' length as the number of sample in the input peak table.
#' @return object of class of
#' \link[SummarizedExperiment]{SummarizedExperiment}.
#' \link[SummarizedExperiment]{RangedSummarizedExperiment-class}.
#'
#' @noRd
check_input_data <- function (df, classes=NULL){
Expand All @@ -89,7 +89,7 @@ check_input_data <- function (df, classes=NULL){
}

#' If input data object was not of class of
#' \link[SummarizedExperiment]{SummarizedExperiment},
#' \link[SummarizedExperiment]{RangedSummarizedExperiment-class},
#' convert output to the original R data structure.
#'
#' All values stored in \code{metadata} element of \code{SummarizedExperiment}
Expand Down
3 changes: 2 additions & 1 deletion R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
#' @references Kirwan et al, Scientific Data volume 1,
#'Article number: 140012 (2014) https://www.nature.com/articles/sdata201412
#'
#' @format A \link[SummarizedExperiment]{SummarizedExperiment} object. \cr
#' @format A \link[SummarizedExperiment]{RangedSummarizedExperiment-class}
#' object. \cr
#' \code{assay(MTBLS79)} Peak intensities of the DIMS data set.
#' Contains 172 samples and 2488 features. \cr
#' \code{colData(MTBLS79)} Sample meta data containing 4 columns. \cr
Expand Down
30 changes: 15 additions & 15 deletions R/filters.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ NULL
#' used to calculate the median signal intensity.
#'
#' @param df A matrix-like (e.g. an ordinary matrix, a data frame) or
#' \link[SummarizedExperiment]{SummarizedExperiment} object with all values of
#' class \code{numeric()} or \code{integer()} of peak intensities, areas or
#' other quantitative characteristic.
#' \link[SummarizedExperiment]{RangedSummarizedExperiment-class} object with
#' all values of class \code{numeric()} or \code{integer()} of peak
#' intensities, areas or other quantitative characteristic.
#' @param fold_change \code{numeric(1)}, fold_change minimum fold change
#' between analytical and blank samples.
#' @param classes \code{character()}, vector of class labels. Must be the same
Expand All @@ -42,9 +42,9 @@ NULL
#' matrix-like (e.g. an ordinary matrix, a data frame) object, function returns
#' \code{numeric()} matrix-like object of filtered data set. Function
#' \code{flags} are added to the object \code{attributes} and is a
#' \link[S4Vectors]{DataFrame} with five columns. The same \code{DataFrame}
#' object containing flags is added to \code{rowData()} element of
#' \code{SummarizedExperiment} object as well.\cr
#' \link[S4Vectors]{DataFrame-class} with five columns. The same
#' \code{DataFrame} object containing flags is added to \code{rowData()}
#' element of \code{SummarizedExperiment} object as well.\cr
#' \cr
#' Columns in \code{rowData()} or \code{flags} element contain: \cr
#' \code{median_non_blanks} median intensities of features of non-blank
Expand Down Expand Up @@ -130,9 +130,9 @@ filter_peaks_by_blank <- function(df, fold_change, classes, blank_label,
#' matrix-like (e.g. an ordinary matrix, a data frame) object, function returns
#' \code{numeric()} matrix-like object of filtered data set. Function
#' \code{flags} are added to the object \code{attributes} and is a
#' \link[S4Vectors]{DataFrame} with five columns. The same \code{DataFrame}
#' object containing flags is added to \code{rowData()} element of
#' \code{SummarizedExperiment} object as well.\cr
#' \link[S4Vectors]{DataFrame-class} with five columns. The same
#' \code{DataFrame} object containing flags is added to \code{rowData()}
#' element of \code{SummarizedExperiment} object as well.\cr
#' \cr
#'
#' Columns in \code{rowData()} or \code{flags} element contain \code{fractions}
Expand Down Expand Up @@ -257,9 +257,9 @@ remove_peaks <- function(df, rem_index) {
#' matrix-like (e.g. an ordinary matrix, a data frame) object, function returns
#' \code{numeric()} matrix-like object of filtered data set. Function
#' \code{flags} are added to the object \code{attributes} and is a
#' \link[S4Vectors]{DataFrame} with five columns. The same \code{DataFrame}
#' object containing flags is added to \code{rowData()} element of
#' \code{SummarizedExperiment} object as well.\cr
#' \link[S4Vectors]{DataFrame-class} with five columns. The same
#' \code{DataFrame-class} object containing flags is added to \code{rowData()}
#' element of \code{SummarizedExperiment} object as well.\cr
#' \cr
#' Columns in \code{rowData()} or \code{flags} element contain: \cr
#' \code{rsd_QC} \code{numeric()}, RSD\% value of QC samples per feature; \cr
Expand Down Expand Up @@ -311,9 +311,9 @@ filter_peaks_by_rsd <- function(df, max_rsd, classes, qc_label,
#' matrix-like (e.g. an ordinary matrix, a data frame) object, function returns
#' \code{numeric()} matrix-like object of filtered data set. Function
#' \code{flags} are added to the object \code{attributes} and is a
#' \link[S4Vectors]{DataFrame} with five columns. The same \code{DataFrame}
#' object containing flags is added to \code{rowData()} element of
#' \code{SummarizedExperiment} object as well. If element
#' \link[S4Vectors]{DataFrame-class} with five columns. The same
#' \code{DataFrame} object containing flags is added to \code{rowData()}
#' element of \code{SummarizedExperiment} object as well. If element
#' \code{colData()} already exists flags are appended to existing values.\cr
#' \cr
#'
Expand Down
3 changes: 2 additions & 1 deletion man/MTBLS79.Rd

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

6 changes: 3 additions & 3 deletions man/QCRSC.Rd

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

12 changes: 6 additions & 6 deletions man/filter_peaks_by_blank.Rd

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

12 changes: 6 additions & 6 deletions man/filter_peaks_by_fraction.Rd

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

12 changes: 6 additions & 6 deletions man/filter_peaks_by_rsd.Rd

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

12 changes: 6 additions & 6 deletions man/filter_samples_by_mv.Rd

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

6 changes: 3 additions & 3 deletions man/glog_plot_optimised_lambda.Rd

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

6 changes: 3 additions & 3 deletions man/glog_transformation.Rd

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

6 changes: 3 additions & 3 deletions man/mv_imputation.Rd

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

6 changes: 3 additions & 3 deletions man/normalise_to_sum.Rd

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

6 changes: 3 additions & 3 deletions man/pqn_normalisation.Rd

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

6 changes: 3 additions & 3 deletions man/processing_history.Rd

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

6 changes: 3 additions & 3 deletions man/remove_peaks.Rd

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

6 changes: 3 additions & 3 deletions man/sbc_plot.Rd

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

0 comments on commit de6b432

Please sign in to comment.