search

biocore / wetlab-assistant

BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

added manual for plate_mapper #2

Closed qiyunzhu closed 7 years ago

qiyunzhu commented 7 years ago

I created a user's guide for plate_mapper. It is in static HTML format (because GitHub markdown lacks certain formatting function). Please download this file and view in a browser. So far I defined the input file format standards. This is based on conversations between me and Greg. I tried to be as compatible as possible with the wet lab's convention. The spreadsheet may not sound like a computationally efficient format, but that's what the wet lab are used to dealing with.

mortonjt commented 7 years ago

I think this looks good. But it looks like a plate_mapper module needs to be defined first. Want to push that in first before merging this in? Just in case there are changes to the readme.

qiyunzhu commented 7 years ago

@mortonjt Thanks! By module do you mean the actual Python code? It is in progress now. In the manual I defined the question we are going to solve, then I wrote a script to solve this question. Does that sound logic?

mortonjt commented 7 years ago

👍 so let's wait to merge this.

sjanssen2 commented 7 years ago

As far as I understand this PR it is only about the concept (i.e. the description in the HTML file). By merging this, we would give @qiyunzhu the go to code something. So why and for what should we wait here @mortonjt ?