jbloomlab / seqneut-pipeline

Pipeline for analyzing sequencing-based neutralization assays
MIT License
0 stars 0 forks source link

specify counts columns in manual_drops #46

Closed ckikawa closed 6 months ago

ckikawa commented 6 months ago

This pull request should resolve #45 by adding additional elif statements to a cell of process_plate.ipynb where manual_drops are removed from the counts dataframe. I tested this with multiple wells on some recent H3N2 ngs-neut data.

As is, single wells/barcodes cannot be specified in lists (as indicated in README). They must be added as individual lines with dashes. If this is expected behavior, ignore this comment. Otherwise, I can add this detail to README?

anloes commented 6 months ago

I think we should add instructions to the README.md, if was not immediately obvious that this is what should be done, an example would work.

anloes commented 6 months ago

Yes, you are correct that this was a bug fix. However, there is not currently an example of how a single well or a barcode should be listed for exclusion. It was unclear if they should be in brackets around the entry or if these could just be listed as strings. I would recommend we update the README.md section on manual drops to show an example of each, i.e.:

manual_drops: barcode_serum_replicates:

jbloom commented 6 months ago

It should just be a list, which can be specified in either of two ways in YAML:

wells: [A1, A2]

or

wells:
  - A1
  - A2

It says this verbally in README, but you can add in example if you want @ckikawa

ckikawa commented 6 months ago

@jbloom, I see. I think this was just a YAML formatting quirk that I wasn't familiar with. I was trying (and failing) with:

wells:
  - [A1, A2]

I've updated the CHANGELOG but I'm not sure an example in README is necessary.