Re: [Microbe] [Kbase-devel] Comments from users at GLBRC retreat
Awesome. As tutorials are updated, please conform to the structural requirements that iris needs to parse them out, then I can link 'em all into there as well. In iris, type 'tutorial list' to get the list of tutorials, and then click on "How to create an iris tutorial" and that'll talk you through the structure. It's basically structured as the pages currently are, just tacking on a 'id="tutorial" to the container, and wrapping individual steps in div tags. So modifications should be minimal. But once that's in place, any pages that follow the structure can be linked into iris and runnable there as well. -- -Jim Thomason... Computational Science Developer @ The Ware Lab, a USDA-ARS Laboratory at Cold Spring Harbor Laboratory http://www.warelab.org/ http://www.cshl.edu/ On May 24, 2013, at 4:33 PM, Elizabeth M. Glass <[email protected]<mailto:[email protected]>> wrote: Thanks Chris! Just as FYI - 2. Good comment and easily fixed. 3. Lynn and I are reviewing the command-line help and a command summary is an item we would like to see added along with a usage example for each, as most end users will still have trouble deciphering how to use it. We are reorging the tutorials site as we speak - it is too confusing with it all mixed together. Elizabeth ----- Original Message ----- From: Christopher Henry <[email protected]<mailto:[email protected]>> To: kbase devel <[email protected]<mailto:[email protected]>>, [email protected]<mailto:[email protected]> Outreach <[email protected]<mailto:[email protected]>>, KBase Microbes List <[email protected]<mailto:[email protected]>> Cc: Doreen Ware <[email protected]<mailto:[email protected]>> Sent: Fri, 24 May 2013 16:26:59 -0500 (CDT) Subject: [Microbe] Comments from users at GLBRC retreat Hi all, I'm going to do a brain dump of comments from users at the GLBRC retreat. I figure everyone should see these. Doreen, can you add to this list? 1.) David Benton said we should do everything in "awk", but I think he was kidding :) 2.) Yury Bukhman said we shouldn't refer to the apps in KBase labs as prototypes, because it scares everyone away from using them. Currently, the KBase slide stack calls them prototypes. 3.) Audry Gasch gave some awesome input. She was incredibly supporting and helpful during my demo. Here's a few of her comments: -She found the "usage" of the current commands confusing (but she did like that it was there). She thinks the command "usage" should always start with a high level sentence explaining what the command do. -She found the documentation on the KBase website overwhelming. In particular, she didn't like how the "Command line" documentation and the "Web API" documentation was all mixed together. She would have preferred to see those separated out. But also, she would like to see the same sort of "command links" that you have in IRIS in www.kbase.us<http://www.kbase.us> as well, where you can go to "Modeling Scripts", then look for your command of interest, and click on it to see detailed descriptions. She also said the command documentation was also too low level. It didn't provide high-level descriptions of what each command was fundamentally meant to do. -She wanted ALL the documentation to be available somehow online within IRIS. For example, could she type "annnotate_genome --docs" and see the complete documentation of the command with all detail thats on www.kbase.us<http://www.kbase.us> instead of just the command usage -She loved the idea of the tutorials being built into IRIS, but there needs to be better descriptions of how to use them there. -Audrey said she won't use anything in KBase unless she has a good understanding of the fundamental methods the commands use in the background. In the other words, our command documentation should contain links to the papers describing their methods whenever possible, or detailed descriptions of the entire method when no paper exists (e.g. she wants to know that RAST is the annotation technology behind our annotation commands, and Model SEED is the tech behind our modeling commands). 4.) After I ran "fastsa-to-genome" and "annotate-genome", many users asked if they could now go and see their genome in the Workspace Browser and in the Genome Browser. 5.) Steven Slater said he wants his agrobacteria community to set up a workspace with snapshots of all the agrobacteria genomes in KBase, then he wanted his community to be able to annotate those genomes there and share them as the best available agrobacteria annotations available. He also ultimately wanted to see these get integrated into the automatically propagated annotations. 6.) Generally, there was the question is how JGI data would be available in KBase… do we replicate it, or is it "just there" Chris _______________________________________________ Microbe mailing list [email protected]<mailto:[email protected]> https://lists.kbase.us/mailman/listinfo/microbe _______________________________________________ Kbase-devel mailing list [email protected] https://lists.kbase.us/mailman/listinfo/kbase-devel
participants (1)
-
Thomason, James