Mercurial > repos > pieterlukasse > primv_visualization
changeset 0:a13b9fcbc0ee
Push to main toolshed
| author | pieter.lukasse@wur.nl |
|---|---|
| date | Wed, 08 Jan 2014 12:44:02 +0100 |
| parents | |
| children | 492f92862ab5 |
| files | CytoExport.jar LICENSE NOTICE README.rst cytoexport.xml datatypes_conf.xml static/images/tood.png |
| diffstat | 7 files changed, 385 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LICENSE Wed Jan 08 12:44:02 2014 +0100 @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/NOTICE Wed Jan 08 12:44:02 2014 +0100 @@ -0,0 +1,16 @@ +PRIMV-visualization toolset & Galaxy wrappers +========================================== + +Tools and wrappers for the PRIMV visualization toolset. +Suite of tools that generate multi-purpose views to assist in the visualization +and interpretation of large and complex datasets. + +Can be used a.o. in combination with PRIMS-MASSCOMB (prims_masscomb package) and +PRIMS-proteomics (prims_proteomics package). + +Copyright 2010-2013 by Pieter Lukasse, Plant Research International (PRI), +Wageningen, The Netherlands. All rights reserved. See the license text below. + +Galaxy wrappers and installation are available from the Galaxy Tool Shed at: +http://toolshed.g2.bx.psu.edu/view/pieterlukasse/primv_visualization +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.rst Wed Jan 08 12:44:02 2014 +0100 @@ -0,0 +1,67 @@ +PRIMV-visualization toolset & Galaxy wrappers +============================================= + +Visualization module of Plant Research International's Multi-purpose Views (PRIMV) toolsuite. + +This toolset consists of tools that generate multi-purpose views to assist in the visualization +and interpretation of large and complex datasets. + +Can be used a.o. in combination with PRIMS-MASSCOMB (prims_masscomb package) and +PRIMS-proteomics (prims_proteomics package). + +Copyright 2010-2013 by Pieter Lukasse, Plant Research International (PRI), +Wageningen, The Netherlands. All rights reserved. See the license text below. + +Galaxy wrappers and installation are available from the Galaxy Tool Shed at: +http://toolshed.g2.bx.psu.edu/view/pieterlukasse/primv_visualization + +History +======= + +============== ======================================================================== +Date Changes +-------------- ------------------------------------------------------------------------ +January 2014 -first release via Tool Shed +November 2013 -cytoexport tool used internally at PRI +October 2012 -first tool for generating visually rich Cytoscape networks (cytoexport) +============== ======================================================================== + +Tool Versioning +=============== + +Tools will have versions of the form X.Y.Z. Versions +differing only after the second decimal should be completely +compatible with each other. Breaking changes should result in an +increment of the number before and/or after the first decimal. All +tools of version less than 1.0.0 should be considered beta. + + +Bug Reports & other questions +============================= + +For the time being issues can be reported via the contact form at +http://www.wageningenur.nl/en/Persons/PNJ-Pieter-Lukasse.htm + +Developers, Contributions & Collaborations +========================================== + +If you wish to join forces and collaborate on some of the +tools do not hesitate to contact Pieter Lukasse via the contact form above. + +License (Apache, Version 2.0) +============================= + +Copyright 2013 Pieter Lukasse, Plant Research International (PRI). + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this software except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/cytoexport.xml Wed Jan 08 12:44:02 2014 +0100 @@ -0,0 +1,90 @@ +<tool name="CytoExport" id="cytoexport1" version="1.0.2"> + <description>Exports CSV files to visually rich Cytoscape networks</description> + <!-- + For remote debugging start you listener on port 8000 and use the following as command interpreter: + java -jar -Xdebug -Xrunjdwp:transport=dt_socket,address=D0100564.wurnet.nl:8000 + ////////////////////////// + This part is a WORKAROUND for the Cytoscape X11 dependency problem, even when running 'headless' (assuming Xfvb is installed/enabled): + export DISPLAY=:995; + ...TODO -> this is linux specific...follow issue fix on Cytoscape...perhaps we can add try/catch in python here (see http://www.unix.com/shell-programming-scripting/107334-how-use-catch-try-final-bash-script.html) + ...check how other tools do this + --> + <command interpreter="export DISPLAY=:995; java -jar "> + CytoExport.jar + -networkName "$csvDataFile.metadata.base_name" + -csvDataFile $csvDataFile + -configInputMode $configInputMode.type + -vizMapPropsFile $configInputMode.vizMapPropsFile + -vizStyleName $vizStyleName + -alternativeTableImportJsonFile $configInputMode.alternativeTableImportJsonFile + -cysOutFile $cysOutFile + -htmlReportFile $htmlReportFile + -picturesPath $htmlReportFile.files_path + -logFile $logFile + </command> + + <inputs> + <!-- TODO make possible to have multiple networks in same .cys + <param name="networkName" type="text" size="30" value="" label="Network name" />--> + <param name="csvDataFile" type="data" format="csv,tabular" label="Network data file" /> + + + <conditional name="configInputMode"> + <param name="type" type="select" label="Configuration input"> + <option value="customConfig" selected="true">Use custom configuration files</option> + <option value="existingTemplate">Use one of the existing templates</option> + </param> + <when value="existingTemplate"> + <param name="alternativeTableImportJsonFile" type="select" label="Select import template"> + <option value="/com/pri/cytoexport/resources/simple_xtandem_out.json" >Config for X!Tandem .csv</option> + <option value="/com/pri/cytoexport/resources/quantifere_network_config.json" >Config for Quantifere .csv (force-directed layout)</option> + <option value="/com/pri/cytoexport/resources/quantifere_network_config_no_layout.json" >Config for Quantifere .csv (no layout)</option> + </param> + <param name="vizMapPropsFile" type="select" label="Select vizualization template"> + <option value="/com/pri/cytoexport/resources/simple_xtandem_viz.props" >Plain1 for X!Tandem .csv</option> + <option value="/com/pri/cytoexport/resources/quantifere_network_layout.props" >Plain1 for Quantifere .csv</option> + </param> + </when> + <when value="customConfig"> + <param name="alternativeTableImportJsonFile" type="data" format="json" label="Alternative TableImport configuration file" help="The configuration file generated by the 'AlternativeTableImport' plugin"/> + <param name="vizMapPropsFile" type="data" format="any" label="VizMap file" /> + </when> + </conditional> + + <param name="vizStyleName" type="text" size="30" value="default" label="VizMap style to apply" + help="In which file to display the network"/> + + </inputs> + <outputs> + <data name="htmlReportFile" format="html" label="${csvDataFile.metadata.base_name} - ${tool.name} on ${on_string}: preview" metadata_source="csvDataFile"/> + <data name="cysOutFile" format="cys" label="${csvDataFile.metadata.base_name} - ${tool.name} on ${on_string}: Cytoscape .CYS" metadata_source="csvDataFile"/> + <data name="logFile" format="txt" label="${csvDataFile.metadata.base_name} - ${tool.name} on ${on_string}: logfile" metadata_source="csvDataFile"/> + </outputs> + <tests> + </tests> + <help> + +.. class:: infomark + +This tool takes in the CSV file and transforms it into a Cytoscape network according to the +configurations found in the 'Alternative TableImport configuration file'. + +It provides pipeline automation for generating a visually rich Cytoscape network, which can +also be achieved manually by using the `AlternativeTableImport plugin`_ for Cytoscape. + + +----- + +**Output details** + +`See AlternativeTableImport for more details...`__ + + +.. __: javascript:window.open('http://apps.cytoscape.org/apps/alternativetableimport','popUpWindow','height=800,width=1000,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes') +.. _AlternativeTableImport plugin: javascript:window.open('http://apps.cytoscape.org/apps/alternativetableimport','popUpWindow','height=800,width=1000,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes') + + + + + </help> +</tool>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/datatypes_conf.xml Wed Jan 08 12:44:02 2014 +0100 @@ -0,0 +1,10 @@ +<?xml version="1.0"?> +<datatypes> + <datatype_files> + </datatype_files> + <registration display_path="display_applications"> + <!-- type for the cytoscape export tool output --> + <datatype extension="cys" type="galaxy.datatypes.data:Data" mimetype="application/octet-stream" + display_in_upload="true" subclass="true"/> + </registration> +</datatypes> \ No newline at end of file