startSession: startSession

Description Usage Arguments Details Value Author(s) Examples

View source: R/machinaWS.functions.R

Description

This connects to Machina web service, sending user credentials and other parameters if desired, and returns the machi.na session object to R.

Usage

1
2
3
4
5
6
7
8
    startSession(
    	userName = NULL,
    	password = NULL,
    	serviceHost = "account.machi.na",
    	protocol = "https",
    	strategyCallback = viewStrategy,
    	verbose = FALSE
		)

Arguments

userName

Your Machi.na user ID

password

Your password

serviceHost

Not required, this will default to 'account.machi.na'

protocol

Not required, defaults to 'https'

strategyCallback

Not required, this will default to viewStrategy

verbose

Not required, this will default to FALSE

Details

This connects to Machina web service, sending user credentials and other parameters if desired, and returns the Machina session object to R.

Value

This function returns the Machina session object.

Author(s)

Michael Gursky

Examples

1
  #  startSession("billy@email.com", "password")

machina documentation built on May 2, 2019, 10:21 a.m.