board_deparse: Deparse a board object

View source: R/board.R

board_deparseR Documentation

Deparse a board object

Description

Returns the R code that would recreate the board when re-run on another computer. Goal is to capture the location of the board, but not the authorisation, since (a) that would leak credentials and (b) in most deployment scenarios board auth will be read from env vars.

Usage

board_deparse(board, ...)

## S3 method for class 'pins_board_azure'
board_deparse(board, ...)

## S3 method for class 'pins_board_connect'
board_deparse(board, ...)

## S3 method for class 'pins_board_folder'
board_deparse(board, ...)

## S3 method for class 'pins_board_gcs'
board_deparse(board, ...)

## S3 method for class 'pins_board_kaggle_competition'
board_deparse(board, ...)

## S3 method for class 'pins_board_kaggle_dataset'
board_deparse(board, ...)

## S3 method for class 'pins_board_s3'
board_deparse(board, ...)

Arguments

board

A pin board, created by board_folder(), board_connect(), board_url() or another board_ function.

...

Additional arguments passed on to methods for a specific board.

Value

A call.

Examples

## Not run: 
board <- board_connect()
# Generate code to access this board from elsewhere
board_deparse(board)

## End(Not run)

pins documentation built on Jan. 22, 2023, 1:55 a.m.