omnipath.options

omnipath.options = Options(url='https://omnipathdb.org', license=None, cache=<FileCache[size=0, path='/home/docs/.cache/omnipathdb']>, autoload=True, convert_dtypes=True, num_retries=3, timeout=600, chunk_size=8196)

Class defining various omnipath options.

Parameters:

• url – URL of the web service.

• license – License to use when fetching the data.

• password – Password used when performing requests.

• cache –

  Type of a cache. Valid options are:

  • None: do not save anything into a cache.

  • ’memory’: cache files into the memory.

  • str: persist files into a directory.

• autoload – Whether to contact the server at url during import to get the server version and the most up-to-date query parameters and their valid options.

• convert_dtypes – Whether to convert the data types of the resulting pandas.DataFrame.

• num_retries – Number of retries before giving up.

• timeout – Timeout in seconds when awaiting response.

• chunk_size – Size in bytes in which to read the data.

• progress_bar – Whether to show the progress bar when downloading data.