Issue 32: Change to plot titles displaying

[rossdrucker]

Updated margins in create_plot_base() so that plot titles will be shown when a display range is provided per #32

Summary by CodeRabbit

• Bug Fixes
  • Fixed faceting in {ggplot2}.
  • Corrected a link in the vignette.
  • Addressed an issue with plot titles not displaying correctly.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sporty-r	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 15, 2024 8:59am

[coderabbitai]

Walkthrough

The sportyR package version 2.2.1 brings improvements like fixing faceting in {ggplot2}, correcting a vignette link, and resolving plot title display issues. These changes enhance user experience and functionality across the package.

Changes

File Path	Change Summary
.../sportyR/package_utils.R	Fixed faceting in {ggplot2}
.../sportyR/vignettes/guide.Rmd	Corrected a broken link in the vignette
.../sportyR/plotting/plot_titles.R	Addressed plot title display issue

🐇🎨
In the land of sporty code,
Fixes made, a smoother road.
Facets now dance with glee,
Plot titles shine, for all to see! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e10dd84 and f182dfb.

Files selected for processing (1)

• R/plot-helpers.R (1 hunks)

Additional comments: 1

R/plot-helpers.R (1)

• 22-24: The adjustment of plot.margin settings from -1 to 0 for top (t) and bottom (b) margins in the create_plot_base function is a targeted fix to ensure plot titles are displayed correctly when a display range is specified. This change directly addresses the issue reported and follows best practices for setting margins in ggplot2 to improve plot readability and user experience.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (af86511) 99.90% compared to head (f182dfb) 99.90%.
Report is 6 commits behind head on main.

❗ Current head f182dfb differs from pull request most recent head 9c39296. Consider uploading reports for the commit 9c39296 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files          25       25           
  Lines        8410     8410           
=======================================
  Hits         8402     8402           
  Misses          8        8           

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

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f182dfb and 9c39296.

Files selected for processing (1)

• NEWS.md (1 hunks)

[coderabbitai]

Ensure the issue link for #32 is correctly formatted. It currently reads issues32 which will lead to a broken link. It should be issues/32.

- Fixed [#32](https://github.com/sportsdataverse/sportyR/issues32) with plot titles not displaying correctly
+ Fixed [#32](https://github.com/sportsdataverse/sportyR/issues/32) with plot titles not displaying correctly

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	- Fixed [#32](https://github.com/sportsdataverse/sportyR/issues32) with plot titles not displaying correctly
	- Fixed [#32](https://github.com/sportsdataverse/sportyR/issues/32) with plot titles not displaying correctly