python-igraph manual

For using igraph from Python

   Home       Trees       Indices       Help   
Package igraph :: Package remote :: Module nexus :: Class NexusDatasetInfo
[hide private]

Class NexusDatasetInfo

source code

object --+
         |
        NexusDatasetInfo

Information about a dataset in the Nexus repository.

Instance Methods [hide private]
 
__init__(self, id=None, sid=None, name=None, networks=None, vertices=None, edges=None, tags=None, attributes=None, rest=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__repr__(self)
repr(x)
source code
 
__str__(self)
str(x)
source code
 
download(self, network_id=None)
Retrieves the actual dataset from Nexus.
source code
 
get(self, network_id=None)
Retrieves the actual dataset from Nexus.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]
 
FromMultiDict(cls, dict)
Constructs a Nexus dataset object from a multidict representation of key-value pairs, similar to the ones provided by the Nexus API in plain text response.
source code
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, id=None, sid=None, name=None, networks=None, vertices=None, edges=None, tags=None, attributes=None, rest=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

download(self, network_id=None)

source code 

Retrieves the actual dataset from Nexus.

Parameters:
  • network_id - if the dataset contains multiple networks, the ID of the network to be retrieved. None returns a single network if the dataset contains a single network, or a dictionary of networks if the dataset contains more than one network. "*" retrieves a dictionary even if the dataset contains a single network only.
Returns:
a Graph instance or a dictionary mapping network names to Graph instances.

get(self, network_id=None)

source code 

Retrieves the actual dataset from Nexus.

Parameters:
  • network_id - if the dataset contains multiple networks, the ID of the network to be retrieved. None returns a single network if the dataset contains a single network, or a dictionary of networks if the dataset contains more than one network. "*" retrieves a dictionary even if the dataset contains a single network only.
Returns:
a Graph instance or a dictionary mapping network names to Graph instances.

   Home       Trees       Indices       Help