pepkit / looper

A job submitter for Portable Encapsulated Projects
http://looper.databio.org
BSD 2-Clause "Simplified" License
20 stars 7 forks source link

adding an output explanation page to summarizer results #290

Closed nsheff closed 8 months ago

nsheff commented 4 years ago

@jpsmith5 wrote a glossary for pepatac output here: https://pepatac.databio.org/en/latest/glossary/

actually, it almost looks like the information in the output schema.

Could we put this info into the output schemas, and then display this information automatically in the looper summary page? what do you think?

-Nathan

donaldcampbelljr commented 1 year ago

Would this be a a static page created during the HTML Report generation that simply lists the output schema that was used to report the results? Description would be the glossary definition?

pipeline_name: test_pipe
samples:
  collection_of_images:
    description: "This store collection of values or objects"
    type: array
    items:
      properties:
          prop1:
            description: "This is an example file"
            type: file
  output_file_in_object:
    type: object
    properties:
      prop1:
        description: "This is an example file"
        type: file
      prop2:
        description: "This is an example image"
        type: image
    description: "Object output"
  output_file:
    type: file
    description: "This a path to the output file"
  output_image:
    type: image
    description: "This a path to the output image"
project:
  another_collection_of_images:
    description: "This store collection of values or objects"
    type: array
    items:
      properties:
        prop1:
          description: "This is an example file"
          type: file
donaldcampbelljr commented 1 year ago

This is still desired.

donaldcampbelljr commented 1 year ago

Current output from pipestat.summarize: image

nleroy917 commented 12 months ago

Something I saw in the code class="table-sm". You might want to do class="table table-sm" instead.

donaldcampbelljr commented 12 months ago

https://getbootstrap.com/docs/4.0/utilities/spacing/

<tbody>  
    {% for element in items %}  
        {% set i = loop.index - 1 %}  
        <tr>  
            <td class="pl-1">  
                {{ items[i] }}  
            </td>  
            <td class="pl-1">  
                {{ descriptions[i] }}  
            </td>  
        </tr>    {% endfor %}  
</tbody>