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

Remove support for Kaggle boards #698

Merged
merged 5 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ VignetteBuilder:
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.2
RoxygenNote: 7.2.3
3 changes: 3 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
* Functions for viewing legacy API pins in the RStudio Viewer pane are now
deprecated (when possible) or removed (#679).

* The functions for accessing Kaggle resource as pins are no longer supported.
We recommend you use the Kaggle CLI instead (#698).

## Other improvements

* Added vignette describing how to manage custom formats (#631, @ijlyttle).
Expand Down
7 changes: 6 additions & 1 deletion R/board_kaggle.R
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
#' Use kaggle datasets/competitions as a board
#'
#' @description
#' These functions are no longer supported because of changes to the Kaggle
#' API and will be removed in a future version of pins. We recommend that you
#' use the [Kaggle CLI](https://www.kaggle.com/docs/api) instead.
#'
#' `board_kaggle_competition()` allows you to treat a Kaggle competition like
#' a read-only board, making it easy get the data on to your computer.
#' `board_kaggle_dataset()` lets you upload and download files to and from a
#' kaggle dataset. Data is only re-downloaded when it changes.
#'
#' These boards work best with `pin_download()` and `pin_upload()` since
#' `pin_read()` and `pin_write()` are not a good fit to the kaggle model.
#' `pin_read()` and `pin_write()` are not a good fit to the Kaggle model.
#'
#' @name board_kaggle
#' @keywords internal
#' @param username,key Typically you'll authenticate using the
#' `"~/.kaggle/kaggle.json"` file downloaded from your account page
#' (by clicking "Create New API Token". However, if necessary you can supply
Expand Down
5 changes: 5 additions & 0 deletions R/legacy_kaggle.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#' Kaggle board (legacy API)
#'
#' These functions are no longer supported because of changes to the Kaggle
#' API and will be removed in a future version of pins. We recommend that you
#' use the [Kaggle CLI](https://www.kaggle.com/docs/api) instead.
#'
#' To use a Kaggle board, you need to first download a token file from
#' your account.
#'
Expand All @@ -14,6 +18,7 @@
#' @param token The Kaggle token as a path to the `kaggle.json` file, can
#' be `NULL` if the `~/.kaggle/kaggle.json` file already exists.
#' @inheritParams new_board
#' @keywords internal
#' @examples
#' \dontrun{
#' # the following example requires a Kaggle API token
Expand Down
1 change: 0 additions & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ reference:
contents:
- board_azure
- board_local
- board_kaggle_dataset
- board_ms365
- board_connect
- board_s3
Expand Down
7 changes: 6 additions & 1 deletion man/board_kaggle.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions man/legacy_kaggle.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

76 changes: 0 additions & 76 deletions tests/testthat/test-board_kaggle.R

This file was deleted.

15 changes: 0 additions & 15 deletions tests/testthat/test-legacy_kaggle.R

This file was deleted.