Difference between revisions of "Nanguiano Individual Assessement"

From LMU BioDB 2015
Jump to: navigation, search
(finished this up. just need link to the report)
(added report link)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<!-- ADD REPORT LINK -->
 
 
=== Statement of Work ===
 
=== Statement of Work ===
On my project, I completed a successful export of [https://github.com/lmu-bioinformatics/xmlpipedb/tree/master/GenMAPP%20Gene%20Databases/V.%20cholerae/%23current V. cholerae] which solved the problems I had faced in the [[Nanguiano_Week_9|initial export I had attempted]]. To perform the export, I modified an existing [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/godb/xsd/go_daily-obo-xml-manual.dtd GO OBO-XML DTD schema] to work with [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/GenMAPP%20Gene%20Databases/V.%20cholerae/%23current/source_files/go_daily-termdb.obo-xml a new OBO-XML file] that used a schema that no longer worked with GenMAPP Builder. I ran [https://github.com/lmu-bioinformatics/xmlpipedb/tree/master/xsd2db xsd2db] on the manually edited DTD file to obtain files that could be used in GenMAPP Builder. I ran [https://github.com/lmu-bioinformatics/xmlpipedb/tree/master/godb/tools GODB Post Processor] on the specified [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/godb/hbm/To.hbm.xml HBM] and [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/godb/sql/schema.sql SQL] files to allow them to be properly added to GenMAPP Builder. I replaced the old files in GenMAPP Builder with the new files generated by xsd2db and GODBPostProcessor, and overwrote [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/gmbuilder/sql/gmbuilder.sql GMBuilder.sql] with the contents of the schema.sql file that was edited by GODB Post Processor so that it could build the proper table initially. I wrote [https://github.com/lmu-bioinformatics/xmlpipedb/wiki/Updating-GMBuilder-to-work-GO's-OBO-XML-Files documentation on how to perform updates to GMBuilder] in the event of an OBO-XML schema change in the future. Following all of this, I performed an export of V. cholerae, which completed successfully. Then I performed quality assurance on the export, the details of which can be found in the  
+
On my project, I completed a successful export of [https://github.com/lmu-bioinformatics/xmlpipedb/tree/master/GenMAPP%20Gene%20Databases/V.%20cholerae/%23current V. cholerae] which solved the problems I had faced in the [[Nanguiano_Week_9|initial export I had attempted]]. To perform the export, I modified an existing [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/godb/xsd/go_daily-obo-xml-manual.dtd GO OBO-XML DTD schema] to work with [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/GenMAPP%20Gene%20Databases/V.%20cholerae/%23current/source_files/go_daily-termdb.obo-xml a new OBO-XML file] that used a schema that no longer worked with GenMAPP Builder. I ran [https://github.com/lmu-bioinformatics/xmlpipedb/tree/master/xsd2db xsd2db] on the manually edited DTD file to obtain files that could be used in GenMAPP Builder. I ran [https://github.com/lmu-bioinformatics/xmlpipedb/tree/master/godb/tools GODB Post Processor] on the specified [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/godb/hbm/To.hbm.xml HBM] and [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/godb/sql/schema.sql SQL] files to allow them to be properly added to GenMAPP Builder. I replaced the old files in GenMAPP Builder with the new files generated by xsd2db and GODBPostProcessor, and overwrote [https://github.com/lmu-bioinformatics/xmlpipedb/blob/master/gmbuilder/sql/gmbuilder.sql GMBuilder.sql] with the contents of the schema.sql file that was edited by GODB Post Processor so that it could build the proper table initially. I wrote [https://github.com/lmu-bioinformatics/xmlpipedb/wiki/Updating-GMBuilder-to-work-GO's-OBO-XML-Files documentation on how to perform updates to GMBuilder] in the event of an OBO-XML schema change in the future. Following all of this, I performed an export of V. cholerae, which completed successfully. Then I performed quality assurance on the export, the details of which can be found in the [[Media:NA_Final_Report.docx|report]]. Following this, I converted the [https://xmlpipedb.cs.lmu.edu XMLPipeDB website] to Jekyll, and moved it to a [https://github.com/lmu-bioinformatics/xmlpipedb/tree/gh-pages gh-pages branch] on github, giving it a new [http://lmu-bioinformatics.github.io/xmlpipedb/ github domain]. The primary website was redirected to the github site link. Following this, I ran [http://schemaspy.sourceforge.net/ SchemaSpy] on the database, the results of which can be found [http://lmu-bioinformatics.github.io/xmlpipedb/assets/schemaspy/uniprotdb/ here for uniprotdb], [http://lmu-bioinformatics.github.io/xmlpipedb/assets/schemaspy/godb/ here for godb], and [http://lmu-bioinformatics.github.io/xmlpipedb/assets/schemaspy/gmbuilderdb/ here for gmbuilder]. I also wrote up [https://github.com/lmu-bioinformatics/xmlpipedb/wiki/Using-SchemaSpy documentation on how to use SchemaSpy] for future reference.
 
+
Report  <!-- ADD LINK HEREEEE -->
+
 
+
. Following this, I converted the [https://xmlpipedb.cs.lmu.edu XMLPipeDB website] to Jekyll, and moved it to a [https://github.com/lmu-bioinformatics/xmlpipedb/tree/gh-pages gh-pages branch] on github, giving it a new [http://lmu-bioinformatics.github.io/xmlpipedb/ github domain]. The primary website was redirected to the github site link. Following this, I ran [http://schemaspy.sourceforge.net/ SchemaSpy] on the database, the results of which can be found [http://lmu-bioinformatics.github.io/xmlpipedb/assets/schemaspy/uniprotdb/ here for uniprotdb], [http://lmu-bioinformatics.github.io/xmlpipedb/assets/schemaspy/godb/ here for godb], and [http://lmu-bioinformatics.github.io/xmlpipedb/assets/schemaspy/gmbuilderdb/ here for gmbuilder]. I also wrote up [https://github.com/lmu-bioinformatics/xmlpipedb/wiki/Using-SchemaSpy documentation on how to use SchemaSpy] for future reference.
+
  
 
=== Assessment of Project ===
 
=== Assessment of Project ===
Line 12: Line 7:
 
I am very pleased with the results of my work on the V. cholera export (and corresponding edits to GMBuilder), the XMLPipeDB site, and the SchemaSpy documentation. The export and quality assurance performed seemed to indicate that the edits to GMBuilder will allow for future GO OBO-XML files to run smoothly without error, provided another DTD schema change does not occur. However, should one occur in the future, the documentation written should make the process much smoother for future developers. Due to the use of Github, I would say the project was very organized. Tasks and accomplishments were clearly marked, and questions and concerns were generally kept in their relevant threads. The entire process from beginning to end is documented fully on [https://github.com/lmu-bioinformatics/xmlpipedb/issues github's issues], in issues both opened and closed as of the time of this writing. Additionally, all code written and changed can be found in the [https://github.com/lmu-bioinformatics/xmlpipedb github repository] for XMLPipeDB. It is my belief that Github allowed for this project to run very smoothly and for all correspondences to be recorded without confusion.
 
I am very pleased with the results of my work on the V. cholera export (and corresponding edits to GMBuilder), the XMLPipeDB site, and the SchemaSpy documentation. The export and quality assurance performed seemed to indicate that the edits to GMBuilder will allow for future GO OBO-XML files to run smoothly without error, provided another DTD schema change does not occur. However, should one occur in the future, the documentation written should make the process much smoother for future developers. Due to the use of Github, I would say the project was very organized. Tasks and accomplishments were clearly marked, and questions and concerns were generally kept in their relevant threads. The entire process from beginning to end is documented fully on [https://github.com/lmu-bioinformatics/xmlpipedb/issues github's issues], in issues both opened and closed as of the time of this writing. Additionally, all code written and changed can be found in the [https://github.com/lmu-bioinformatics/xmlpipedb github repository] for XMLPipeDB. It is my belief that Github allowed for this project to run very smoothly and for all correspondences to be recorded without confusion.
  
I did find the creation of the report to be very difficult due to the nature of the class this semester. However, for the most part, I feel as though it was fully complete. The only sections not completed were those using GenMAPP (as GenMAPP crashes upon running on my computer), and the database schema diagram (though the SchemaSpy results on the website may be a substitute for this).
+
I did find the creation of the report to be very difficult due to the nature of the class this semester, at least within the scope of the existing report guidelines. However, for the most part, I feel as though it was fully complete. The only sections not completed were those using GenMAPP (as GenMAPP crashes upon running on my computer), and the database schema diagram (though the SchemaSpy results on the website may be a substitute for this).
  
 
=== Reflection on the Process ===
 
=== Reflection on the Process ===

Latest revision as of 12:30, 21 December 2016

Statement of Work

On my project, I completed a successful export of V. cholerae which solved the problems I had faced in the initial export I had attempted. To perform the export, I modified an existing GO OBO-XML DTD schema to work with a new OBO-XML file that used a schema that no longer worked with GenMAPP Builder. I ran xsd2db on the manually edited DTD file to obtain files that could be used in GenMAPP Builder. I ran GODB Post Processor on the specified HBM and SQL files to allow them to be properly added to GenMAPP Builder. I replaced the old files in GenMAPP Builder with the new files generated by xsd2db and GODBPostProcessor, and overwrote GMBuilder.sql with the contents of the schema.sql file that was edited by GODB Post Processor so that it could build the proper table initially. I wrote documentation on how to perform updates to GMBuilder in the event of an OBO-XML schema change in the future. Following all of this, I performed an export of V. cholerae, which completed successfully. Then I performed quality assurance on the export, the details of which can be found in the report. Following this, I converted the XMLPipeDB website to Jekyll, and moved it to a gh-pages branch on github, giving it a new github domain. The primary website was redirected to the github site link. Following this, I ran SchemaSpy on the database, the results of which can be found here for uniprotdb, here for godb, and here for gmbuilder. I also wrote up documentation on how to use SchemaSpy for future reference.

Assessment of Project

Overall, I would say the project was a success. The initial goal for the semester was completed, and the following goals of converting the XMLPipeDB website to Jekyll and moving it to github were also complete. The most successful aspects of the project were the parts that combined my knowledge with that of Dr. Dionisio and Dr. Dahlquist. Many of the tasks I completed this semester worked with things I'd never worked with before, like ant, hibernate, and xml. Attempting to complete work on my own was often fruitless, as not knowing what I was doing often made it difficult to search for precisely what I needed to do. Working with the professors to learn what they learn instead of trying to do it all myself allowed things to progress much more quickly. If I were to do it again, I would come to them for aid much sooner than I did so as to avoid days of struggle attempting to figure out errors that were very easily recognizable by others.

I am very pleased with the results of my work on the V. cholera export (and corresponding edits to GMBuilder), the XMLPipeDB site, and the SchemaSpy documentation. The export and quality assurance performed seemed to indicate that the edits to GMBuilder will allow for future GO OBO-XML files to run smoothly without error, provided another DTD schema change does not occur. However, should one occur in the future, the documentation written should make the process much smoother for future developers. Due to the use of Github, I would say the project was very organized. Tasks and accomplishments were clearly marked, and questions and concerns were generally kept in their relevant threads. The entire process from beginning to end is documented fully on github's issues, in issues both opened and closed as of the time of this writing. Additionally, all code written and changed can be found in the github repository for XMLPipeDB. It is my belief that Github allowed for this project to run very smoothly and for all correspondences to be recorded without confusion.

I did find the creation of the report to be very difficult due to the nature of the class this semester, at least within the scope of the existing report guidelines. However, for the most part, I feel as though it was fully complete. The only sections not completed were those using GenMAPP (as GenMAPP crashes upon running on my computer), and the database schema diagram (though the SchemaSpy results on the website may be a substitute for this).

Reflection on the Process

I feel that this project was an excellent learning experience. Almost everything I worked with this semester was entirely new, allowing me to expand my knowledge with every week. The primary things on the technical and computer science spectrum that I learned were:

  • XML structure and elements, and how to add a new element to an XML file
  • How to use Ant, and how to build files with it
  • How to edit Ant build files to allow files to build that aren't building
  • How to build a website with Maven
  • How to convert Maven to Jekyll
  • How to update GMBuilder to work with new OBO-XML Files
  • How to use SchemaSpy

On the personal side, I learned to ask questions when I have them rather than always trying to answer my questions on my own. This is a lesson I have faced many times throughout my college career, but I feel it was especially relevant here. Days spent struggling to decode cryptic error messages or figure out code that simply wasn't working could have been solved in minutes should I just have asked. While I still value striving to answer questions on my own and feel that it is very important to learning new concepts in computer science, I believe there are times in which it is infinitely more beneficial to ask for help. Asking for help doesn't always mean being given the answer, as I often fear it is. It can often mean just being given a direction on where to go in order to discover an answer. This is a lesson I will carry with me for years to come.