qsirecon.utils.boilerplate module

Functions to generate boilerplate text for reports.

class qsirecon.utils.boilerplate.ConditionalDoc(if_true, if_false='', if_undefined=None)

Bases: object

Store conditional documentation for a Nipype Interface input.

This is only useful for inputs that are specified when the interface is initialized. It will not work for inputs that are set through workflow connections.

Parameters:

• if_true (str) – The string to use if the input’s value is not False or _Undefined. This string may have a value variable to incorporate (e.g., “The value is {value}.”), but it will still work if not.

• if_false (str, optional) – The string to use if the input’s value is False. Default is an empty string.

• if_undefined (str or None, optional) – The string to use if the input’s value is Undefined. If not specified, the string from if_false will be used instead.

Returns:

The formatted string from the appropriate input (if_true, if_false, or if_undefined).

Return type:

str

Examples

>>> doc = ConditionalDoc(if_true="A passing test.", if_false="A failing test.")
>>> doc.get_doc(value='value')
"A passing test."

>>> doc = ConditionalDoc(if_true="Value of {value}.", if_false="A failing test.")
>>> doc.get_doc(value=3000)
"Value of 3000."

get_doc(value)

qsirecon.utils.boilerplate.build_documentation(interface)

Build documentation for a given interface.

This is only useful for inputs that are specified when the interface is initialized. It will not work for inputs that are set through workflow connections.

It will work with either the original interface object or a Nipype Node. It has not been tested with MapNodes or JoinNodes.

qsirecon.utils.boilerplate.describe_atlases(atlases)

Build a text description of the atlases that will be used.

qsirecon.utils.boilerplate.list_to_str(lst)

Convert a list to a pretty string.