Pipeline interface needs to have a way to tell the summarizer what it produces

[nsheff]

Spin-off from #30

How about adding a section like this to pipeline_interface.yaml:

    summary_results:
      "Alignment file": "summary/{project_name}.alignmentPercent.pdf"
      "Library size file": "summary/{project_name}.LibSize.pdf"

the idea is that there would be a few reserved keyword variables like {project_name} that would refer to project attributes, which may be used. or some other way of referring to items in the project config, since the files may want to be named with that information.

[nsheff]

New proposed format enables thumbnails and descriptions:

    summary_results:
      - alignment_file:
        caption: "Alignment file"
        description: "Plots alignment rates to all pre-alignments and primary genome."
        thumbnail_path: "summary/{name}.alignmentPercent.png"
        path: "summary/{name}.alignmentPercent.pdf"
      - lib_file:
        caption: "Library size file"
        thumbnail_path: "summary/{name}.LibSize.png"
        path: "summary/{name}.LibSize.pdf"

[nsheff]

Here {name} will be any project-level attribute

[nsheff]

Now implemented in #34.

[nsheff]

You can see this in action now in pepatac:

https://github.com/databio/pepatac/blob/master/pipeline_interface.yaml

[nsheff]

Before I close this we need to document this in the pipeline interface documentation.

[vreuter]

@nsheff this can be closed if the added docs are satisfactory; feel free obviously to change as you see fit

[nsheff]

thanks vince. That's great for now. I think I need to comprehensively re-vamp the pipeline interface docs so I'll leave it open for now