You're reading an old version of this documentation. If you want up-to-date information, please have a look at stable (v1.6.0).

Welcome to file-tree’s documentation!

This is the documentation for file-tree, a project designed to allow you to separate the directory structure of your pipeline inputs/outputs from the actual pipeline code.

Install using

pip install file-tree file-tree-fsl

Include the file-tree-fsl package if you want to use filetree definitions for the FSL tools.

• FileTree tutorial
  • Introduction
  • FileTree interactivity
  • FileTree indendation
  • Template keys
  • Placeholders
    • Placeholder types
    • Placeholder iteration
    • Setting placeholder values
    • Linked placholder values
  • Optional Placeholders
  • Sub-trees
  • Including external files
  • Updating templates
  • Writing filetrees
  • Example neuroimaging pipeline
    • Changing directory structure
    • Output “basenames”
• Changes with respect to FileTree in fslpy
• file-tree package
  • file_tree.file_tree module
    • FileTree
    • convert()
  • file_tree.parse_tree module
  • file_tree.template module
    • Literal
    • MyDataArray
    • OptionalPart
    • Part
    • Placeholders
    • Required
    • Template
    • TemplateParts
    • extract_placeholders()
    • is_singular()