Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

tonywu1999
Copy link
Contributor

@tonywu1999 tonywu1999 commented Oct 31, 2024

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

  • I have read the MSstats contributing guidelines
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules
  • I have run the devtools::document() command after my changes and committed the added files

PR Type

Documentation


Description

  • Added comprehensive documentation for the dataProcess function, detailing the structure and columns of the FeatureLevelData and ProteinLevelData return values.
  • Enhanced the groupComparison function documentation by describing the components of the return value, including ComparisonResult, ModelQC, and FittedModel.
  • Updated the corresponding Rd files to reflect these documentation improvements.

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

    Copy link

    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

    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @tonywu1999 tonywu1999 merged commit f494c87 into devel Nov 6, 2024
    2 checks passed
    @tonywu1999 tonywu1999 deleted the documentation branch November 6, 2024 22:43
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant