Skip to content

Commit d7d0fb5

Browse files
authored
docs(fractions): Update documentation around fractionation (#136)
1 parent 3145427 commit d7d0fb5

20 files changed

Lines changed: 109 additions & 28 deletions

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ License: Artistic-2.0
1414
Encoding: UTF-8
1515
LazyData: true
1616
Roxygen: list(markdown = TRUE)
17-
RoxygenNote: 7.3.3
1817
biocViews: MassSpectrometry, Proteomics, Software, DataImport, QualityControl
1918
Depends:
2019
R (>= 4.0)
@@ -82,3 +81,4 @@ Collate:
8281
'utils_logging.R'
8382
'utils_shared_peptides.R'
8483
VignetteBuilder: knitr
84+
Config/roxygen2/version: 8.0.0

R/utils_documentation.R

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
#' @param removeFewMeasurements TRUE (default) will remove the features that have 1 or 2 measurements across runs.
66
#' @param useUniquePeptide TRUE (default) removes peptides that are assigned for more than one proteins.
77
#' We assume to use unique peptide for each protein.
8-
#' @param summaryforMultipleRows max or sum - when there are multiple measurements for certain feature and certain run, use highest or sum of multiple intensities. Default is max for label-free converters and sum for TMT converters.
8+
#' @param summaryforMultipleRows max or sum - when multiple PSMs identify
9+
#' the same feature within a single MS run (duplicate PSMs), use the
10+
#' highest (max) or sum of the duplicate intensities. Default is max for
11+
#' label-free converters and sum for TMT converters. Note that this parameter
12+
#' does NOT control collapsing across fractions of the same biological mixture.
913
#' @param removeProtein_with1Feature TRUE will remove the proteins which have only 1 feature, which is the combination of peptide, precursor charge, fragment and charge. FALSE is default.
1014
#' @param removeProtein_with1Peptide TRUE will remove the proteins which have only 1 peptide and charge. FALSE is default.
1115
#' @param removeOxidationMpeptides TRUE will remove the peptides including 'oxidation (M)' in modification. FALSE is default.

man/DIAUmpiretoMSstatsFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/FragPipetoMSstatsFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MSstatsConvert.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MaxQtoMSstatsFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MaxQtoMSstatsTMTFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MetamorpheusToMSstatsFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/OpenMStoMSstatsFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/OpenSWATHtoMSstatsFormat.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)