how to extend versioning in a board

[ponkoscel]

Hi,

Do you have any guidance on how to extend/implement versioning for a custom board?

It does not appear in this example: https://cran.r-project.org/web/packages/pins/vignettes/boards-extending.html

Attempting something like this:

#' @title pin_versions
#' @description retrieve the pin versions
#' @param board the "my_board" base board, initialized with the users connection parameters
#' @param name the name of the resource to delete, e.g. "iris"
#' @param ... extra parameters
#' @export
board_pin_versions.my_board <- function(board, name, ...) {
board_versions_get(board, name)
}

works, but only if I source this function after either loading my extended board with devtools::load_all() or by sourcing this function after installing my custom board package. Thanks!

[javierluraschi]

If you create an R package and export the board_pin_versions.my_board function, that should be enough for users to use pin_versions() when using your custom board.

BTW. The easiest way to create a board extension is to reuse the datatxt_board, which requires implementing GET/PUT/DELETE HTTP methods. Although, this only works for boards that have an HTTP API similar to the various cloud providers. Otherwise you would have to implement all the board methods by hand.

[javierluraschi]

Also, is there a particular error you are hitting? I'm assuming this is a generic question, but otherwise let me know.

[ponkoscel]

Thanks for the quick response. We implemented a custom board as it requires accessing another platform using the platforms specific APIs. The code above only works in conjunction with our custom board, if I use devtools::load_all(), and then source the above function. Then I can retrieve the resource versions from the server. However, if I install my custom board package from our package server OR I run devtools::load_all() and do not source the function above I simply get an empty tibble.

[javierluraschi]

Looks like board_pin_versions() was not being exported from the pins package, I'll merge this fix later today, you can then install this with remotes::install_github("rstudio/pins").

We just pushed to CRAN a minor release, so it will take another month to get this fix into CRAN.

[github-actions]

This issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.