docs(dataProcess+groupComparison): Add documentation on output tables of dataProcess and groupComparison #142
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User description
Motivation and Context
We've been getting a good amount of questions on the MSstats google groups on what certain columns mean in the output of dataProcess and groupComparison. We should add documentation.
Checklist Before Requesting a Review
PR Type
Documentation
Description
dataProcess
function, detailing the structure and columns of theFeatureLevelData
andProteinLevelData
return values.groupComparison
function documentation by describing the components of the return value, includingComparisonResult
,ModelQC
, andFittedModel
.Changes walkthrough 📝
dataProcess.R
Add detailed return value documentation for `dataProcess` function
R/dataProcess.R
dataProcess
function.
FeatureLevelData
andProteinLevelData
.groupComparison.R
Add detailed return value documentation for
groupComparison
functionR/groupComparison.R
groupComparison
function.ComparisonResult
,ModelQC
, andFittedModel
.dataProcess.Rd
Update documentation for `dataProcess` function return value
man/dataProcess.Rd
value.
FeatureLevelData
andProteinLevelData
.groupComparison.Rd
Update documentation for `groupComparison` function return value
man/groupComparison.Rd
value.
ComparisonResult
,ModelQC
, andFittedModel
.