brapi_imagebreed_login: post /token for ImageBreed.org

View source: R/brapi_imagebreed_login.R

brapi_imagebreed_loginR Documentation

post /token for ImageBreed.org

Description

Login into ImageBreed.

Usage

brapi_imagebreed_login(user = "", password = "")

Arguments

user

character; Username to be used, when logging in is required. Default is "".

password

character; Password to be used for the specified user, when logging in is required. Default is "".

Details

Using the POST /token call for authentication a user can login to ImageBreed.org to obtain a valid token from within R and use with additional BrAPI R functions. The password is NOT stored in the connection object for safety.

Value

A list object of class 'brapi_con' with the authentication token filled to make BrAPI calls in R from the ImageBreed database.

Author(s)

brapir generator package

References

BrAPI Specs GitHub

See Also

Other brapiutils: as.brapi_db(), brapi_canInternet(), brapi_checkCon(), brapi_connect(), brapi_db(), brapi_imagebreed_logout(), brapi_login(), brapi_serverinfo_show(), is.brapi_con(), print.brapi_con(), print.brapi_db()

Examples

## Not run: 

# Login to ImageBreed.org with R
con <- brapi_imagebreed_login(user = "USERNAME_HERE",
                              password = "PASSWORD_HERE")

## End(Not run)


mverouden/brapir documentation built on April 10, 2022, 5:36 p.m.