search

UCSF-DSCOLAB / data_processing_pipelines

A repository to store the existing pipelines to process the various CoLabs datasets
0 stars 1 forks source link

Create README.md for example-inputs #30

Closed erflynn closed 12 months ago

erflynn commented 12 months ago

Describes files and toy data generation

dtm2451 commented 12 months ago

This is great, just also posting here that it'd be great to be able to use 1 single config file for pre_qc and post_qc. If that can be enacted, we'd update the description of param_2v2.json.

dtm2451 commented 12 months ago

I'd also recommend that we document somewhere what each element of the config file controls. I don't see that anywhere else? I think either this readme, within the config file examples themselves (if we can safely put comments into the json?), or within the main readme are the best spots for that.

erflynn commented 12 months ago

I'll add to this README. unfortunately it looks like we cannot but comment characters in json :/

erflynn commented 12 months ago

@dtm2451 --added config description in commit f3c960d

dtm2451 commented 12 months ago

Biased towards merge now to have these in place for my pending meeting, but I do have some notes that could be for a future PR.