print.NDExConnection: Print a NDExConnection object

View source: R/ndex_connect.r

print.NDExConnectionR Documentation

Print a NDExConnection object

Description

This function creates an NDExConnection which stores options and authentication details. It is a parameter required for most of the other ndexr functions. If username and password are missing an anonymous connection is created, which already offers most of the retrieval functionality.

Usage

## S3 method for class 'NDExConnection'
print(x, ...)

Arguments

x

NDExConnection; stores options, authentication and api configuration

...

further arguments passed to or from other methods.

Value

Just prints the NDExConnection object

See Also

ndex_connect and ndex_config

Examples

ndexcon = ndex_connect()   ## log in anonymously
print(ndexcon)
ndexcon = ndex_connect(verbose=TRUE)   ## same as above with extended feedback
print(ndexcon)
## Not run: 
## log in with credentials
ndexcon = ndex_connect('user','password')
print(ndexcon)
## running some NDEx server locally
ndexcon = ndex_connect(host='localhost:8765')
print(ndexcon)
## manually change the api and connection configuration
ndexcon = ndex_connect(ndexConf=ndex_config$Version_2.0)
print(ndexcon)

## End(Not run)

frankkramer-lab/ndexr documentation built on April 4, 2023, 7:19 p.m.