byu-dnasc / proto-smrtlink-share

0 stars 1 forks source link

Define the directory structures which can result from staging a dataset #27

Open adknaupp opened 2 months ago

adknaupp commented 2 months ago

A staging directory (i.e. a directory created for staging files associated with a given dataset) may contain various directories depending on what types of files belong to the dataset.

parent dataset and children

<parent_dataset_name>
├── run_metrics
│   ├── metrics.json
│   └── metrics.txt
└── <child_name>
    ├── prefix.fastq
    ├── prefix.bam.pbi
    └── prefix.bam

Default

<staging directory>
├── prefix.fastq
├── prefix.bam.pbi
└── prefix.bam

Dataset directory name derivation

parent_dir_name = f'Run {dataset.movie_id} - {dataset.name}'
child_dir_name = f'{child_ds.name} ({child_ds.barcode})'

# Create function to produce these names
def dir(dataset: Dataset):
    ...