Vitek-Lab / MSstats

R package - MSstats
74 stars 46 forks source link

docs(dataProcess+groupComparison): Add documentation on output tables of dataProcess and groupComparison #142

Closed tonywu1999 closed 1 week ago

tonywu1999 commented 2 weeks ago

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


Changes walkthrough πŸ“

Relevant files
Documentation
dataProcess.R
Add detailed return value documentation for `dataProcess` function

R/dataProcess.R
  • Added detailed documentation for the return value of the dataProcess
    function.
  • Described the structure and columns of FeatureLevelData and
    ProteinLevelData.
  • +39/-1   
    groupComparison.R
    Add detailed return value documentation for groupComparison function

    R/groupComparison.R
  • Added detailed documentation for the return value of the
    groupComparison function.
  • Described the structure and columns of ComparisonResult, ModelQC, and
    FittedModel.
  • +36/-2   
    dataProcess.Rd
    Update documentation for `dataProcess` function return value

    man/dataProcess.Rd
  • Updated documentation to include detailed description of the return
    value.
  • Described the structure and columns of FeatureLevelData and
    ProteinLevelData.
  • +39/-0   
    groupComparison.Rd
    Update documentation for `groupComparison` function return value

    man/groupComparison.Rd
  • Updated documentation to include detailed description of the return
    value.
  • Described the structure and columns of ComparisonResult, ModelQC, and
    FittedModel.
  • +36/-2   

    πŸ’‘ PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    github-actions[bot] commented 2 weeks ago

    PR Reviewer Guide πŸ”

    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
    github-actions[bot] commented 2 weeks ago

    PR Code Suggestions ✨

    No code suggestions found for the PR.