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 metadata-convention-compliant metadata file (SCP-2832) #111

Closed jlchang closed 4 years ago

jlchang commented 4 years ago

To improve metadata convention adoption, provide an example metadata-convention-compliant metadata file. This example file does not contain biosample_type (in anticipation of making biosample_type an optional metadata, SCP-2806, to be completed this sprint), but has all other required metadata plus cell type and an example (non-convention) numeric annotation.

This satisfies SCP-2832.

codecov[bot] commented 4 years ago

Codecov Report

Merging #111 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #111   +/-   ##
=======================================
  Coverage   23.01%   23.01%           
=======================================
  Files          17       17           
  Lines        2876     2876           
=======================================
  Hits          662      662           
  Misses       2214     2214           

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 9446a55...985b704. Read the comment docs.

jlchang commented 4 years ago

Content looks good, but please add "metadata" somewhere in the file name, e.g. perhaps mc_compliant_metadata_example.txt. That will help users (and us) recall at a glance what this file is for.

Updated file name in c728f23. Thanks for the suggestion!