biocore / my-microbes

A set of tools for delivering personal microbiome results to individuals participating in microbiome sequencing studies.
7 stars 5 forks source link

top-level index page that we can use to highlight the system and a few results #16

Closed gregcaporaso closed 11 years ago

gregcaporaso commented 11 years ago

In addition to the per-student index pages, we should have a top-level index page for the website that contains information about the project, the delivery system, and anything else we want to put in there.

I wonder if we could host all of this on gh-pages... if file size is a limitation, we could drop the rarefaction plots.

jairideout commented 11 years ago

Since we're only needing to serve static pages, I think the system could be hosted on github.

gregcaporaso commented 11 years ago

and it's free, so that's good

jairideout commented 11 years ago

Each individual's results are around 70MB right now, so we'll quickly overstep github's 1GB limit.

Looks like the taxa summary plots comprise most of the space- if we only include the necessary files (i.e. exclude OTU tables, taxa summary files, etc.) we can drop this to roughly half the size, but we'll still exceed our limit when we have results for all individuals.

gregcaporaso commented 11 years ago

what if we dropped the alpha rarefaction plots? are those taking a lot of space?

jairideout commented 11 years ago

No, those are only taking ~1MB per individual.

gregcaporaso commented 11 years ago

OK, we should probably scratch the hosting on GitHub idea - agreed?

jairideout commented 11 years ago

Agreed.

jairideout commented 11 years ago

After our meeting yesterday, it was determined that we need the index page to have a table listing personal IDs and links to the personalized results.

@gregcaporaso is going to look into whether we'd be better off hosting this on S3 or someplace else (e.g. on thebeast?).

gregcaporaso commented 11 years ago

Right, the idea is that on a per-run basis we'll want to make our own index page to highlight various things about the project. Having a table of links to per-individual results will just be useful so we have the links to all of the results to use in the index page that we derived from this auto-generated one. So, don't spend any time making this one look pretty - the only exception would be that if you put css together for other pages, make that accessible in this document as well so we can use that in the index that we create for a consistent look-and-feel.

jairideout commented 11 years ago

Pull request was merged that adds a script to generate these tables. Leaving this issue open as we don't have the index page yet. I'm thinking we'll put this together during the code sprint on Tuesday- does this sound okay to you @gregcaporaso?

gregcaporaso commented 11 years ago

Yes, that's fine.

jairideout commented 11 years ago

@gregcaporaso, can you start putting together text for the main index page? I can then fit that into the existing layout/styles.

gregcaporaso commented 11 years ago

yep, now issue #73

gregcaporaso commented 11 years ago

ok, this text is now ready (my_microbes.format.top_level_index_text) so should be ready for you to generate the page.

jairideout commented 11 years ago

Do we want a full list of all individuals that participated in the study (i.e. a list of personal IDs that link to each of the personalized results)? I put a script together for that already, but not sure if we're still wanting to present that info or not.

gregcaporaso commented 11 years ago

is it easy to do in an accordion at the bottom (Links to de-identified personal microbiome data could be the title)?

jairideout commented 11 years ago

Yeah, should be easy to add.