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(getSubnetworkFromIndra): Switch MSstats as dependency, adjust link to groupComparison #22

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

tonywu1999
Copy link
Contributor

@tonywu1999 tonywu1999 commented Nov 6, 2024

User description

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
  • Ran styler::style_pkg(transformers = styler::tidyverse_style(indent_by = 4))
  • Ran devtools::document()

PR Type

documentation, enhancement


Description

  • Updated the DESCRIPTION file to move MSstats from Suggests to Imports, ensuring it is a required dependency.
  • Enhanced the documentation in R/getSubnetworkFromIndra.R and man/getSubnetworkFromIndra.Rd by linking to the groupComparison function from MSstats.
  • Removed unnecessary seealso section from man/getSubnetworkFromIndra.Rd.
  • Fixed minor formatting issues in the man/visualizeNetworks.Rd documentation.

Changes walkthrough 📝

Relevant files
Dependencies
DESCRIPTION
Update package dependencies in DESCRIPTION file                   

DESCRIPTION

  • Added MSstats to the Imports section.
  • Removed MSstats from the Suggests section.
  • +2/-2     
    Documentation
    getSubnetworkFromIndra.R
    Enhance documentation with proper function linking             

    R/getSubnetworkFromIndra.R

  • Updated documentation to use \code{\link[MSstats]{groupComparison}}
    for linking.
  • +4/-4     
    getSubnetworkFromIndra.Rd
    Improve manual with function linking and cleanup                 

    man/getSubnetworkFromIndra.Rd

  • Updated documentation to include
    \code{\link[MSstats]{groupComparison}}.
  • Removed seealso section.
  • +4/-6     
    visualizeNetworks.Rd
    Correct formatting in visualizeNetworks documentation       

    man/visualizeNetworks.Rd

    • Fixed minor formatting issues in the documentation.
    +4/-4     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    github-actions bot commented Nov 6, 2024

    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
    ⚡ Recommended focus areas for review

    Dependency Management
    The PR moves 'MSstats' from 'Suggests' to 'Imports', making it a required dependency. Ensure that this change aligns with the project's dependency management strategy and that it does not introduce any issues with package installation or usage.

    Documentation Update
    The documentation for the function 'getSubnetworkFromIndra' has been updated to include a link to the 'groupComparison' function from 'MSstats'. Verify that this link is correctly formatted and functional.

    Copy link

    github-actions bot commented Nov 6, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @codecov-commenter
    Copy link

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 88.28%. Comparing base (7f7ed54) to head (aa20704).

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##            devel      #22   +/-   ##
    =======================================
      Coverage   88.28%   88.28%           
    =======================================
      Files           3        3           
      Lines         111      111           
    =======================================
      Hits           98       98           
      Misses         13       13           

    ☔ View full report in Codecov by Sentry.
    📢 Have feedback on the report? Share it here.

    @tonywu1999 tonywu1999 merged commit 1af3c5e into devel Nov 6, 2024
    4 checks passed
    @tonywu1999 tonywu1999 deleted the bioc branch November 6, 2024 17:02
    pnavada pushed a commit that referenced this pull request Nov 15, 2024
    …nk to groupComparison (#22)
    
    * docs(getSubnetworkFromIndra): Switch MSstats as dependency, add link to groupComparison
    
    * update manual for visualizeNetworks
    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.

    2 participants