Skip to content

Commit

Permalink
Changes in prep of CRAN. #264
Browse files Browse the repository at this point in the history
  • Loading branch information
pbulsink committed Aug 17, 2024
1 parent 8eabd46 commit 8ee8a3d
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ Rplots.pdf
.DS_Store
docs
/doc/
.RData
.RData
/revdep/
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Authors@R: c(
person("Philip", "Bulsink", , "[email protected]", role = "aut",
comment = c(ORCID = "0000-0001-9668-2429"))
)
Description: Obtain Formula 1 data via the 'Ergast API' <https://ergast.com/mrd/> and the unofficial API <https://www.formula1.com/en/f1-live.html> via the 'fastf1' 'Python' library <https://docs.fastf1.dev/>.
Description: Obtain Formula 1 data via the 'Ergast API' <https://ergast.com/mrd/> and the unofficial API <https://www.formula1.com/en/timing/f1-live> via the 'fastf1' 'Python' library <https://docs.fastf1.dev/>.
Config/reticulate:
list(
packages = list(
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ library(f1dataR)
Data is pulled from:

* [Ergast API](https://ergast.com/mrd/)
* [F1 Data Stream](https://www.formula1.com/en/f1-live.html) via the [Fast F1 python library](https://docs.fastf1.dev/index.html)
* [F1 Data Stream](https://www.formula1.com/en/timing/f1-live) via the [Fast F1 python library](https://docs.fastf1.dev/index.html)

Note the Ergast Motor Racing Database API will be shutting down at the end of 2024. When a new data source is identified the package will be migrated to that source.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ library(f1dataR)
Data is pulled from:

- [Ergast API](https://ergast.com/mrd/)
- [F1 Data Stream](https://www.formula1.com/en/f1-live.html) via the
- [F1 Data Stream](https://www.formula1.com/en/timing/f1-live) via the
[Fast F1 python library](https://docs.fastf1.dev/index.html)

Note the Ergast Motor Racing Database API will be shutting down at the
Expand Down
5 changes: 5 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## Resubmission

This is a minor update to mirror upstream API changes.

Some new functions are added.
An internal dataset is removed (the API now provides this data in a more up-to-date fashion).

This change also removes the `usethis` package from Suggests (it was only incorrectly included for building the internal dataset).
3 changes: 1 addition & 2 deletions vignettes/setup_fastf1.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ setup_fastf1()

This will create a virtual environment using your system's default Python version,
and install `fastf1` in that python environment. It will also tell `reticulate` to use that
environment instead of just running in your main system. For more information on Python
environments read [this article (infoworld.com)](https://www.infoworld.com/article/3239675/virtualenv-and-venv-python-virtual-environments-explained.html).
environment instead of just running in your main system. Many resources exist online to explain python environments in more detail.

# Repeat/Recurring Issues

Expand Down

0 comments on commit 8ee8a3d

Please sign in to comment.