Closed jeandut closed 2 years ago
Hi Jean, could you expand a bit on what you would like to have ?
Specifically, I don't see why we would build a toctree in the readme of each dataset since their subdirectories don't have readmes.
Cheers, Felix
Hi @Grim-bot I just meant to have a section in each README.md that describes the structure of the data as is done in LIDC and in other packages. Nothing automatic just something like what is done for LIDC:
MyDirectory
│
└───LIDC-XML-only
│ │
│ └───tcia-lidc-xml
│ │
│ └─── ...
│ │ │ 158.xml
│ │ │ ...
│ │
│ └─── ...
│
└───1.1.3.6.1.4.1.14519.5.2.1.6279.6001.[SeriesInstanceUID]
│ │ mask_consensus.nii.gz
│ │ mask.nii.gz
│ │ patient.nii.gz
│
│
└───...
Ok this can be done easily manually using tree
but will get out of date again. On the other hand, it's probably not worth automating (complicated and not that important).
Toctrees are good to give an overview on what the data is gonna look lie and are very helpful each dataset should have one. Example: README.md of LIDC-IDRI dataset directory