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

Refactored function names in R/plotting.R #63

Merged
merged 4 commits into from
Oct 8, 2024

Conversation

teddyCodex
Copy link
Collaborator

Description

Refactored specified function names in R/plotting.R based on issue #7

Original Modified User Facing
shorten_lineage shortenLineage
upset.plot plotUpSet
lineage.DA.plot plotLineageDA
lineage.Query.plot plotLineageQuery
lineage.neighbors.plot plotLineageNeighbors
lineage.domain_repeats.plot plotLineageDomainRepeats
LineagePlot plotLineageHeatmap
LevelReduction .LevelReduction
GetKingdom .GetKingdom
stacked_lin_plot plotStackedLineage
Wordcloud3 plotWordCloud3
wordcloud_element createWordCloudElement
wordcloud2_element createWordCloud2Element
lineage_sunburst plotLineageSunburst
lineage.plot plotLineage
  • perhaps a duplicate: COMMENTED OUT LINEAGE.DA.PLOT
    this was commented out about 5yrs ago @jananiravi. okay to delete the entire commented out code block?

Fixes issue #51

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • I have added comments to my code to help provide understanding.
  • I have added a test which covers the code changes found within this PR.
  • I have deleted all non-relevant text in this pull request template.
  • Reviewer assignment: Tag a relevant team member to review and approve the changes.

@teddyCodex
Copy link
Collaborator Author

@the-mayer @jananiravi File containing other locations where the functions are called or referenced.

function_occurrences #51.txt

@the-mayer the-mayer self-assigned this Oct 8, 2024
@the-mayer the-mayer added bug Something isn't working enhancement New feature or request labels Oct 8, 2024
@the-mayer the-mayer linked an issue Oct 8, 2024 that may be closed by this pull request
@the-mayer the-mayer removed the enhancement New feature or request label Oct 8, 2024
@the-mayer
Copy link
Collaborator

Tagging functions for future review.

The following internal functions should be defined outside of the plotting functions that currently use them. This way, the plot functions can reference these external functions, avoiding the need to define functions within functions.

  • .LevelReduction()
  • .GetKingdom()

Copy link
Collaborator

@the-mayer the-mayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some small adjustments, based on other incoming PRs.

Thanks for your contribution @teddyCodex

@the-mayer the-mayer merged commit 92e1017 into JRaviLab:main Oct 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace the function names in R/plotting.R
2 participants