Welcome to file_tree_check’s documentation!

Contents:

• file_tree_check
  • Requirements
• Usage
  • Inputs
  • Outputs
  • Usage as CLI
  • Usage as Python script
• File_Tree
  • Placeholders
  • Subtrees
  • Identifiers
  • Example Trees
• Configuration
  • How to edit a config.ini file
• Demo
  • Running the Demo
• FAQ
  • How do I install this script?
  • When should I use this script?
  • How much time does the script take to run on a large dataset (e.g. UK BioBank)?
  • The script execution seems to be stuck after a few steps
• Glossary
  • Identifier
  • Configuration
  • Path
  • SmartPath
  • Parent
  • Children
  • File Structure / file hierarchy
  • File/directory Name
• file_tree_check package
  • Submodules
  • file_tree_check.fileChecker module
  • file_tree_check.identifierEngine module
  • file_tree_check.main module
  • file_tree_check.smartDirectoryPath module
  • file_tree_check.smartFilePath module
  • file_tree_check.smartPath module
  • file_tree_check.statBuilder module
  • Module contents
• file_tree_check
  • file_tree_check package
• Usage Notes
  • Command-Line Arguments

Indices and tables

• Index

• Module Index

• Search Page