neurostatx.cli.AddNodesAttributes

Attributes

Name	Description
app	Cyclopts application for the AddNodesAttributes command-line tool.

Functions

Name	Description
AddNodesAttributes	Attach tabular labels to graph nodes.

appattributemodule attribute#

View source

app = App(default_parameter=Parameter(negative=()))

Cyclopts application for the AddNodesAttributes command-line tool.

AddNodesAttributesfunction#

View source

def AddNodesAttributes(in_graph: Annotated[str, Parameter(show_default=False, group='Essential Files Options')], in_dataset: Annotated[str, Parameter(show_default=False, group='Essential Files Options')], id_column: Annotated[str, Parameter(show_default=False, group='Essential Files Options')], labels: Annotated[List[str], Parameter(show_default=False, group='Essential Files Options')], out_file: Annotated[str, Parameter(show_default=False, group='Essential Files Options')] = 'graph_with_attributes.gml', verbose: Annotated[bool, Parameter(-v, --verbose, group='Optional parameters')] = False, overwrite: Annotated[bool, Parameter(-f, --overwrite, group='Optional parameters')] = False)

Attach tabular labels to graph nodes.

AddNodesAttributes is a script that sets the attributes of the nodes of a graph. The attributes are provided via a tabulated data format (.csv, .xlsx or .txt) file. The script will automatically match the IDs of the nodes with the IDs of the subjects in the file. Name of the variables to add as attributes can be supplied either via a .txt file or with multiple –labels arguments.

Parameters

Name	Type	Default	Description
in_graph	str	required	Graph file to add attributes to.
in_dataset	str	required	Dataset containing the variables to add as nodes’ attributes to the graph.
id_column	str	required	Name of the column containing the subject’s ID tag. Required for proper handling of IDs and merging multiple datasets.
labels	List[str]	required	Label(s) name(s) to add as nodes’ attributes to the graph. Can be supplied multiple times or as a .txt file containing all names in a line-separated format.
out_file	str	'graph_with_attributes.gml'	Output graph file name (.gml). Defaults to graph_with_attributes.gml.
verbose	bool	False	If true, produce verbose output. Defaults to False.
overwrite	bool	False	If true, force overwriting of existing output files. Defaults to False.

Examples

AddNodesAttributes --in-graph graph.gml --in-dataset dataset.xlsx
--id-column ID --labels label1 --labels label2 --labels label3
--out-file graph_attributes.gexf --verbose