pyNBS.data_import_tools.load_params

Jump to bottom

Justin Huang edited this page Aug 15, 2018 · 2 revisions

This function loads any non-default optional parameters that may be used in the pyNBS pipeline.

Function Call:

load_params(params_file=None)

Parameters:

params_file (optional, str, default=None): Path to parameter file which allows user to specify non-default optional parameters. See Parameters File Format for formatting details. If no file is given, all default values will be set. If only some parameters are given in parameter file, default values will be used for all other parameters. Documentation for parameters that can be read in this file is also given on the pyNBS Parameters File page.

Returns:

run_pyNBS_params (dictionary): Dictionary contains all non-default optional parameters set by the user.