BFClient-class: Class BFClient.

In Blackfynn/blackfynnr: Blackfynn R Client Tool

Description

This is the main interface class for the Blackfynn R client. It handles the session and should be passed to all method calls.

Usage

## S4 method for signature 'BFClient'
initialize(.Object, ...)

## S4 method for signature 'BFClient'
bf.datasets(client)

## S4 method for signature 'BFClient,BFDataset'
contents(client, target)

## S4 method for signature 'BFClient,character'
contents.id(client, id)

Arguments

client	BFClient object
target	"BFDataset" Id of a Dataset, or Collection
client	BFClient client

Value

BFClient object

Methods (by generic)

• initialize: Initializes the BFClient object. It opens a Blackfynn session and stores the API token for the session.

• bf.datasets: Returns a list of Datasets for the organization. This is mroe inof

• contents: Lists the content of a dataset

• contents.id: Get the contents of any object on Blackfynn

  @param client BFClient client @param id "Character" ID of an object in a dataset @export

Slots

scope

The scope in the configuration file

org

The organization for the current session

Blackfynn/blackfynnr documentation built on May 30, 2019, 1:34 p.m.