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

Split out as_forecast() #955

Merged
merged 8 commits into from
Oct 31, 2024
Merged

Split out as_forecast() #955

merged 8 commits into from
Oct 31, 2024

Conversation

nikosbosse
Copy link
Contributor

Description

This PR closes #951.

It

  • removes the as_forecast man page
  • documents the required input formats in the respective as_forecast_<type> man pages and gets rid of a centralised "here is an overview of all input formats" file
  • fixes a few out-of-date things
  • adds a figure with input formats for nominal forecasts

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title as follows: issue-number: PR title
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • I have built the package locally and run rebuilt docs using roxygen2.
  • My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@nikosbosse nikosbosse requested a review from seabbs October 30, 2024 09:12
Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.02%. Comparing base (732b22e) to head (acafaee).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #955      +/-   ##
==========================================
- Coverage   99.32%   99.02%   -0.30%     
==========================================
  Files          22       31       +9     
  Lines        1618     1633      +15     
==========================================
+ Hits         1607     1617      +10     
- Misses         11       16       +5     
Flag Coverage Δ
?

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

Nice this is much easier to use imo

@seabbs seabbs merged commit bbdc711 into main Oct 31, 2024
9 checks passed
@seabbs seabbs deleted the fix-as-forecast branch October 31, 2024 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split out as_forecast documentation
2 participants