Last data update: 2014.03.03

R: Set O*NET API credentials for functional use
setCredsR Documentation

Set O*NET API credentials for functional use

Description

This function allows you to store your O*NET API HTTPS credentials for easy authentication when calling package functions. This function must be used before any other function in the package.

Usage

setCreds(user, pass)

Arguments

user

O*NET API developer username (for the HTTPS API)

pass

O*NET API developer password (for the HTTPS API)

Value

An list to store the API username and password for access by the package functions.

Author(s)

Eric Knudsen

Examples

    # store API username and password
    setCreds("sampleuser","samplepassword")

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(ONETr)
Loading required package: XML
Loading required package: RCurl
Loading required package: bitops
Loading required package: plyr
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/ONETr/setCreds.Rd_%03d_medium.png", width=480, height=480)
> ### Name: setCreds
> ### Title: Set O*NET API credentials for functional use
> ### Aliases: setCreds
> ### Keywords: ~credentials ~authentication
> 
> ### ** Examples
> 
>     # store API username and password
>     setCreds("sampleuser","samplepassword")
API credentials saved. You may now use package functions.
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>