Closed tonywu1999 closed 1 week ago
Here are some key observations to aid the review process:
β±οΈ Estimated effort to review: 2 π΅π΅βͺβͺβͺ |
π§ͺ No relevant tests |
π No security concerns identified |
β‘ No major issues detected |
No code suggestions found for the PR.
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
.