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

Reporting Dummy Pull Request #43

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Reporting Dummy Pull Request #43

wants to merge 10 commits into from

Conversation

jfear
Copy link
Contributor

@jfear jfear commented Jul 29, 2016

This is just a dummy pull request for discussion.

I have added a working example to the mapping workflow. Did a quick and dirty for the count generation, a little hackish but it works.

I am not happy with the interface tool. I think I need to re-vist it now. It needs simplified and I can see some more functionality to add.

I have attached the report (note had to rename to a .txt for upload to github)
report.txt

I will go through on the PR and make some comments line by line.

md = markdown.Markdown(output_format='html5')
tp = ENV.get_template('base.html')
return tp.render(content=md.convert(dedent(string).format(**kwargs)))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still trying to decide how to build table and figure html representations. Right now I am doing it with a rule and saving the HTML chunk. Then importing the report rule. If we think this is best then probably should add a file importing here instead of assuming **kwargs is a string ready for injection.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note that de-indention is huge, because if tabs are not removed then Markdown.convert thinks you are trying to do a code block. I think this should take care of it, but something to look for as we write real reports.

Copy link
Contributor

@daler daler Aug 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to clarify: in this system, each logical chunk of a report will have its own rule to create some HTML. The snakemake infrastructure will identify which rules will need to run and will thereforel be used to determine whether a chunk needs to be built. The final report rule in turn will essentially stitch together the various chunks into one final HTML report. Is that right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think the cleanest/easiest way is to just have a rule for each HTML blob and then use the report rule to write the text and insert the blobs in the correct order.

@jfear jfear changed the title Reporting Dummpy Pull Request Reporting Dummy Pull Request Aug 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants