Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparation of v1.0 release #38

Closed
27 tasks done
strambc opened this issue Jun 17, 2024 · 5 comments
Closed
27 tasks done

Preparation of v1.0 release #38

strambc opened this issue Jun 17, 2024 · 5 comments
Assignees
Labels

Comments

@strambc
Copy link
Collaborator

strambc commented Jun 17, 2024

To do for v1.0 release

  • Add a section to the left-TOC entitled: "Allowable value lists" for all relevant fields

    • Units (##XYZ_unit, Time_unit, Intensity_unit)
    • Cell_Type, Sub-Cell_ROI_type, Extra-Cell_ROI_type etc.
  • For all tables containing only an ID column and OptionalColumn(s) (i.e., bio, rna_bio, quality, rna_quality, trace, cell, subcell, extracell, mapping) : add the following statements:

    • .rst, "The table MUST contain at least 1 optional column.'
    • template, "#^Optional_column_1: [substitute with your column header; the presence of at least 1 optional column is MANDATORY if this table is submitted]
    • table/header: "Conditional requirement: this table MUST contain at least 1 Optional Column."
  • Check all Mandatory, Conditionally Required and Optional table statuses (there are discrepancies between the summary table and the text entered in the .rst)

  • Add credit to Figure 1 (Sarah Aumfkolk)

  • Add credit to Figure 2 (VCF PDF)

    • remove "Fig.3" legend from figure
  • Something wrong with references to rna_bio and rna_quality references in the Summary table

  • Something wrong with the order of tables in the Summary table
    image

  • Add a Section listed in the left-TOC entitled "How to use the Templates"

    • Add content to section
  • Move examples at the end of each Table section (below Header and Columns)

  • Add a note on top of each Example table stating explicitly that the columns in the table are example allowable columns but not mandatory

  • On top of each table-header and table-column put a reference to relevant overview's paragraph to remind people about the meaning of the symbols

  • On top of table.column add BOLD = REQUIRED #42

  • Trace_ID in RNASPOT has to be mandatory

  • All RNA, Table, Cell, SubCell, ExtraCell, and Trace will be set to RECOMMENDED

  • MAKE the following fields MANDATORY

    • #lab_name, #experimenter_name, #experimenter_contact, #description
  • Add a section "Examples and Available datasets"

    • Move available datasets links from miscellaneous to this section
    • Add references to 4DN data portal and IDR
  • Rename "Miscellaneous" to "Additional Information"

@strambc
Copy link
Collaborator Author

strambc commented Jun 18, 2024

  • Optional_column has to have capital "O"

@strambc
Copy link
Collaborator Author

strambc commented Jun 20, 2024

  • Change cell description to include the possibility of reporting MESH structures for segmentation results

@RahiNav
Copy link
Collaborator

RahiNav commented Jun 24, 2024

Completed some of the tasks mentioned. @strambc please take a look

@strambc
Copy link
Collaborator Author

strambc commented Jun 25, 2024 via email

strambc added a commit that referenced this issue Aug 13, 2024
@strambc strambc closed this as completed Aug 28, 2024
@strambc
Copy link
Collaborator Author

strambc commented Aug 28, 2024

On top of table.column add BOLD = REQUIRED  was moved to new issue #42

@strambc strambc reopened this Aug 28, 2024
@strambc strambc closed this as completed Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants