Closed djkapner closed 4 years ago
Merging #101 into master will increase coverage by
0.62%
. The diff coverage is96.61%
.
@@ Coverage Diff @@
## master #101 +/- ##
==========================================
+ Coverage 90.18% 90.80% +0.62%
==========================================
Files 11 13 +2
Lines 550 609 +59
==========================================
+ Hits 496 553 +57
- Misses 54 56 +2
Impacted Files | Coverage Δ | |
---|---|---|
slapp/data_selection/segmentation_manifest.py | 94.87% <94.87%> (ø) |
|
slapp/data_selection/select_data.py | 100.00% <100.00%> (ø) |
|
slapp/data_selection/utils.py | 100.00% <100.00%> (ø) |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update 85bacb6...1de52e9. Read the comment docs.
I got confused reading this document. I think part of the reason is because it assumes that we already know a lot of information about stuff in ophys_segmentation and the structure of our labeling database. I appreciate and like how specific you get in the commands, but I'd like to see more summary information to help guide the reader, and talk about the structure of the examples. It's easy to get stuck in these long query strings.
For example, for the Experiment Selection section, I think it would help the reader not get lost if you outlined the process before providing code examples. Something like:
The select_data
module handles data selection. Based on the input_json passed, it queries the LIMS database to retrieve a list of the appropriate experiment_ids. For reproducibility, it dumps all the IDs and some metadata in an entry in the experiment_selection
table in our Labeling Database. The entry contains the following fields:
< table of fields and explanation>
... Or something like that.
experiment_table
when query results were not same length.experiment_table
entryFollowing the README:
created entry 6:
the next step in the README, building a segmentation manifest:
and