broadinstitute / single_cell_portal

Tutorials, workflows, and convenience scripts for Single Cell Portal
https://singlecell.broadinstitute.org/single_cell
BSD 3-Clause "New" or "Revised" License
47 stars 25 forks source link

add annotated image of mc_example for review #114

Closed jlchang closed 3 years ago

jlchang commented 3 years ago

Please review the text in this image of the annotated metadata convention compliant metadata example file. Credit to Joy for vastly improving the basic concept and generating a beautiful image. We plan to use it in the upload wizard and the wiki.

mc_compliant_metadata_image

The easiest way to review the image text may be through this link - original image

update - cropped image

update - full image

This supports SCP-2775

jlchang commented 3 years ago

Thanks for the suggestions, Eric!

Is the text big enough to read in the intended display destinations? Given the image's aspect ratio and available widths in our wiki and upload wizard, it seems the text size will be small. I believe the design for the wizard is a scrolling box for the image that allows all the annotated bits to be in frame at the outset.

For the wiki, I'll clip the image to fit the width (clipping to cut of text to indicate that there is more to the file that is not being shown).

jlchang commented 3 years ago
  • "Non-conventional names": I suggest "Unconventional names", as the former is rare and the latter is common

I had resisted using "conventional" for quite a while but it does flow better when reading the content of the wiki. I've now changed "non-convention" to "unconventional" in the wiki. I've hesitated in the past to apply the term "unconventional" to what is really "study specific" metadata. "Unconventional" is a more commonly used word but has the connotation of non-standard or not following general practice. The slightly negative connotation has caused me to favor "non-convention" as in not of the convention but I'm willing to try "unconventional".

codecov[bot] commented 3 years ago

Codecov Report

Merging #114 (88dc350) into master (027d6e8) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #114   +/-   ##
=======================================
  Coverage   23.36%   23.36%           
=======================================
  Files          16       16           
  Lines        2833     2833           
=======================================
  Hits          662      662           
  Misses       2171     2171           

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 027d6e8...88dc350. Read the comment docs.