SCasanova / f1dataR

An R package to access Formula 1 Data from the Ergast API and the unofficial F1 data stream via the fastf1 python library.
https://scasanova.github.io/f1dataR/
Other
52 stars 5 forks source link

Document circuit details with Vignette #223

Closed pbulsink closed 6 months ago

pbulsink commented 7 months ago

Includes a few minor code changes in support of enabling load_circuit_details() results to be more friendly (i.e. named list is returned instead of nameless list). Also changes how the plot is squared, in correct_track_ratio() to better handle user-added labels, but the visual effect is the same. Also adds load_circuit_details() to the README

This vignette PR includes demonstration on how to make this plot: image

Feel free to suggest expansion of the text anywhere (reminder to modify *.Rmd.orig then source precompile.R, instead of modifying any *.Rmd vignettes directly).

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.66%. Comparing base (d12eae2) to head (317fc5a).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #223 +/- ## ========================================== + Coverage 95.65% 95.66% +0.01% ========================================== Files 19 19 Lines 598 600 +2 ========================================== + Hits 572 574 +2 Misses 26 26 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

SCasanova commented 6 months ago

Will review today

SCasanova commented 6 months ago

Is this ok to merge?