# HG changeset patch # User ethevenot # Date 1508849042 14400 # Node ID 059eb452931ef50ec10441765b9791dcf3c18fcc planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b diff -r 000000000000 -r 059eb452931e LICENSE.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LICENSE.md Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,517 @@ + CeCILL FREE SOFTWARE LICENSE AGREEMENT + +Version 2.1 dated 2013-06-21 + + + Notice + +This Agreement is a Free Software license agreement that is the result +of discussions between its authors in order to ensure compliance with +the two main principles guiding its drafting: + + * firstly, compliance with the principles governing the distribution + of Free Software: access to source code, broad rights granted to users, + * secondly, the election of a governing law, French law, with which it + is conformant, both as regards the law of torts and intellectual + property law, and the protection that it offers to both authors and + holders of the economic rights over software. + +The authors of the CeCILL (for Ce[a] C[nrs] I[nria] L[ogiciel] L[ibre]) +license are: + +Commissariat à l'énergie atomique et aux énergies alternatives - CEA, a +public scientific, technical and industrial research establishment, +having its principal place of business at 25 rue Leblanc, immeuble Le +Ponant D, 75015 Paris, France. + +Centre National de la Recherche Scientifique - CNRS, a public scientific +and technological establishment, having its principal place of business +at 3 rue Michel-Ange, 75794 Paris cedex 16, France. + +Institut National de Recherche en Informatique et en Automatique - +Inria, a public scientific and technological establishment, having its +principal place of business at Domaine de Voluceau, Rocquencourt, BP +105, 78153 Le Chesnay cedex, France. + + + Preamble + +The purpose of this Free Software license agreement is to grant users +the right to modify and redistribute the software governed by this +license within the framework of an open source distribution model. + +The exercising of this right is conditional upon certain obligations for +users so as to preserve this status for all subsequent redistributions. + +In consideration of access to the source code and the rights to copy, +modify and redistribute granted by the license, users are provided only +with a limited warranty and the software's author, the holder of the +economic rights, and the successive licensors only have limited liability. + +In this respect, the risks associated with loading, using, modifying +and/or developing or reproducing the software by the user are brought to +the user's attention, given its Free Software status, which may make it +complicated to use, with the result that its use is reserved for +developers and experienced professionals having in-depth computer +knowledge. Users are therefore encouraged to load and test the +suitability of the software as regards their requirements in conditions +enabling the security of their systems and/or data to be ensured and, +more generally, to use and operate it in the same conditions of +security. This Agreement may be freely reproduced and published, +provided it is not altered, and that no provisions are either added or +removed herefrom. + +This Agreement may apply to any or all software for which the holder of +the economic rights decides to submit the use thereof to its provisions. + +Frequently asked questions can be found on the official website of the +CeCILL licenses family (http://www.cecill.info/index.en.html) for any +necessary clarification. + + + Article 1 - DEFINITIONS + +For the purpose of this Agreement, when the following expressions +commence with a capital letter, they shall have the following meaning: + +Agreement: means this license agreement, and its possible subsequent +versions and annexes. + +Software: means the software in its Object Code and/or Source Code form +and, where applicable, its documentation, "as is" when the Licensee +accepts the Agreement. + +Initial Software: means the Software in its Source Code and possibly its +Object Code form and, where applicable, its documentation, "as is" when +it is first distributed under the terms and conditions of the Agreement. + +Modified Software: means the Software modified by at least one +Contribution. + +Source Code: means all the Software's instructions and program lines to +which access is required so as to modify the Software. + +Object Code: means the binary files originating from the compilation of +the Source Code. + +Holder: means the holder(s) of the economic rights over the Initial +Software. + +Licensee: means the Software user(s) having accepted the Agreement. + +Contributor: means a Licensee having made at least one Contribution. + +Licensor: means the Holder, or any other individual or legal entity, who +distributes the Software under the Agreement. + +Contribution: means any or all modifications, corrections, translations, +adaptations and/or new functions integrated into the Software by any or +all Contributors, as well as any or all Internal Modules. + +Module: means a set of sources files including their documentation that +enables supplementary functions or services in addition to those offered +by the Software. + +External Module: means any or all Modules, not derived from the +Software, so that this Module and the Software run in separate address +spaces, with one calling the other when they are run. + +Internal Module: means any or all Module, connected to the Software so +that they both execute in the same address space. + +GNU GPL: means the GNU General Public License version 2 or any +subsequent version, as published by the Free Software Foundation Inc. + +GNU Affero GPL: means the GNU Affero General Public License version 3 or +any subsequent version, as published by the Free Software Foundation Inc. + +EUPL: means the European Union Public License version 1.1 or any +subsequent version, as published by the European Commission. + +Parties: mean both the Licensee and the Licensor. + +These expressions may be used both in singular and plural form. + + + Article 2 - PURPOSE + +The purpose of the Agreement is the grant by the Licensor to the +Licensee of a non-exclusive, transferable and worldwide license for the +Software as set forth in Article 5 <#scope> hereinafter for the whole +term of the protection granted by the rights over said Software. + + + Article 3 - ACCEPTANCE + +3.1 The Licensee shall be deemed as having accepted the terms and +conditions of this Agreement upon the occurrence of the first of the +following events: + + * (i) loading the Software by any or all means, notably, by + downloading from a remote server, or by loading from a physical medium; + * (ii) the first time the Licensee exercises any of the rights granted + hereunder. + +3.2 One copy of the Agreement, containing a notice relating to the +characteristics of the Software, to the limited warranty, and to the +fact that its use is restricted to experienced users has been provided +to the Licensee prior to its acceptance as set forth in Article 3.1 +<#accepting> hereinabove, and the Licensee hereby acknowledges that it +has read and understood it. + + + Article 4 - EFFECTIVE DATE AND TERM + + + 4.1 EFFECTIVE DATE + +The Agreement shall become effective on the date when it is accepted by +the Licensee as set forth in Article 3.1 <#accepting>. + + + 4.2 TERM + +The Agreement shall remain in force for the entire legal term of +protection of the economic rights over the Software. + + + Article 5 - SCOPE OF RIGHTS GRANTED + +The Licensor hereby grants to the Licensee, who accepts, the following +rights over the Software for any or all use, and for the term of the +Agreement, on the basis of the terms and conditions set forth hereinafter. + +Besides, if the Licensor owns or comes to own one or more patents +protecting all or part of the functions of the Software or of its +components, the Licensor undertakes not to enforce the rights granted by +these patents against successive Licensees using, exploiting or +modifying the Software. If these patents are transferred, the Licensor +undertakes to have the transferees subscribe to the obligations set +forth in this paragraph. + + + 5.1 RIGHT OF USE + +The Licensee is authorized to use the Software, without any limitation +as to its fields of application, with it being hereinafter specified +that this comprises: + + 1. permanent or temporary reproduction of all or part of the Software + by any or all means and in any or all form. + + 2. loading, displaying, running, or storing the Software on any or all + medium. + + 3. entitlement to observe, study or test its operation so as to + determine the ideas and principles behind any or all constituent + elements of said Software. This shall apply when the Licensee + carries out any or all loading, displaying, running, transmission or + storage operation as regards the Software, that it is entitled to + carry out hereunder. + + + 5.2 ENTITLEMENT TO MAKE CONTRIBUTIONS + +The right to make Contributions includes the right to translate, adapt, +arrange, or make any or all modifications to the Software, and the right +to reproduce the resulting software. + +The Licensee is authorized to make any or all Contributions to the +Software provided that it includes an explicit notice that it is the +author of said Contribution and indicates the date of the creation thereof. + + + 5.3 RIGHT OF DISTRIBUTION + +In particular, the right of distribution includes the right to publish, +transmit and communicate the Software to the general public on any or +all medium, and by any or all means, and the right to market, either in +consideration of a fee, or free of charge, one or more copies of the +Software by any means. + +The Licensee is further authorized to distribute copies of the modified +or unmodified Software to third parties according to the terms and +conditions set forth hereinafter. + + + 5.3.1 DISTRIBUTION OF SOFTWARE WITHOUT MODIFICATION + +The Licensee is authorized to distribute true copies of the Software in +Source Code or Object Code form, provided that said distribution +complies with all the provisions of the Agreement and is accompanied by: + + 1. a copy of the Agreement, + + 2. a notice relating to the limitation of both the Licensor's warranty + and liability as set forth in Articles 8 and 9, + +and that, in the event that only the Object Code of the Software is +redistributed, the Licensee allows effective access to the full Source +Code of the Software for a period of at least three years from the +distribution of the Software, it being understood that the additional +acquisition cost of the Source Code shall not exceed the cost of the +data transfer. + + + 5.3.2 DISTRIBUTION OF MODIFIED SOFTWARE + +When the Licensee makes a Contribution to the Software, the terms and +conditions for the distribution of the resulting Modified Software +become subject to all the provisions of this Agreement. + +The Licensee is authorized to distribute the Modified Software, in +source code or object code form, provided that said distribution +complies with all the provisions of the Agreement and is accompanied by: + + 1. a copy of the Agreement, + + 2. a notice relating to the limitation of both the Licensor's warranty + and liability as set forth in Articles 8 and 9, + +and, in the event that only the object code of the Modified Software is +redistributed, + + 3. a note stating the conditions of effective access to the full source + code of the Modified Software for a period of at least three years + from the distribution of the Modified Software, it being understood + that the additional acquisition cost of the source code shall not + exceed the cost of the data transfer. + + + 5.3.3 DISTRIBUTION OF EXTERNAL MODULES + +When the Licensee has developed an External Module, the terms and +conditions of this Agreement do not apply to said External Module, that +may be distributed under a separate license agreement. + + + 5.3.4 COMPATIBILITY WITH OTHER LICENSES + +The Licensee can include a code that is subject to the provisions of one +of the versions of the GNU GPL, GNU Affero GPL and/or EUPL in the +Modified or unmodified Software, and distribute that entire code under +the terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL. + +The Licensee can include the Modified or unmodified Software in a code +that is subject to the provisions of one of the versions of the GNU GPL, +GNU Affero GPL and/or EUPL and distribute that entire code under the +terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL. + + + Article 6 - INTELLECTUAL PROPERTY + + + 6.1 OVER THE INITIAL SOFTWARE + +The Holder owns the economic rights over the Initial Software. Any or +all use of the Initial Software is subject to compliance with the terms +and conditions under which the Holder has elected to distribute its work +and no one shall be entitled to modify the terms and conditions for the +distribution of said Initial Software. + +The Holder undertakes that the Initial Software will remain ruled at +least by this Agreement, for the duration set forth in Article 4.2 <#term>. + + + 6.2 OVER THE CONTRIBUTIONS + +The Licensee who develops a Contribution is the owner of the +intellectual property rights over this Contribution as defined by +applicable law. + + + 6.3 OVER THE EXTERNAL MODULES + +The Licensee who develops an External Module is the owner of the +intellectual property rights over this External Module as defined by +applicable law and is free to choose the type of agreement that shall +govern its distribution. + + + 6.4 JOINT PROVISIONS + +The Licensee expressly undertakes: + + 1. not to remove, or modify, in any manner, the intellectual property + notices attached to the Software; + + 2. to reproduce said notices, in an identical manner, in the copies of + the Software modified or not. + +The Licensee undertakes not to directly or indirectly infringe the +intellectual property rights on the Software of the Holder and/or +Contributors, and to take, where applicable, vis-à-vis its staff, any +and all measures required to ensure respect of said intellectual +property rights of the Holder and/or Contributors. + + + Article 7 - RELATED SERVICES + +7.1 Under no circumstances shall the Agreement oblige the Licensor to +provide technical assistance or maintenance services for the Software. + +However, the Licensor is entitled to offer this type of services. The +terms and conditions of such technical assistance, and/or such +maintenance, shall be set forth in a separate instrument. Only the +Licensor offering said maintenance and/or technical assistance services +shall incur liability therefor. + +7.2 Similarly, any Licensor is entitled to offer to its licensees, under +its sole responsibility, a warranty, that shall only be binding upon +itself, for the redistribution of the Software and/or the Modified +Software, under terms and conditions that it is free to decide. Said +warranty, and the financial terms and conditions of its application, +shall be subject of a separate instrument executed between the Licensor +and the Licensee. + + + Article 8 - LIABILITY + +8.1 Subject to the provisions of Article 8.2, the Licensee shall be +entitled to claim compensation for any direct loss it may have suffered +from the Software as a result of a fault on the part of the relevant +Licensor, subject to providing evidence thereof. + +8.2 The Licensor's liability is limited to the commitments made under +this Agreement and shall not be incurred as a result of in particular: +(i) loss due the Licensee's total or partial failure to fulfill its +obligations, (ii) direct or consequential loss that is suffered by the +Licensee due to the use or performance of the Software, and (iii) more +generally, any consequential loss. In particular the Parties expressly +agree that any or all pecuniary or business loss (i.e. loss of data, +loss of profits, operating loss, loss of customers or orders, +opportunity cost, any disturbance to business activities) or any or all +legal proceedings instituted against the Licensee by a third party, +shall constitute consequential loss and shall not provide entitlement to +any or all compensation from the Licensor. + + + Article 9 - WARRANTY + +9.1 The Licensee acknowledges that the scientific and technical +state-of-the-art when the Software was distributed did not enable all +possible uses to be tested and verified, nor for the presence of +possible defects to be detected. In this respect, the Licensee's +attention has been drawn to the risks associated with loading, using, +modifying and/or developing and reproducing the Software which are +reserved for experienced users. + +The Licensee shall be responsible for verifying, by any or all means, +the suitability of the product for its requirements, its good working +order, and for ensuring that it shall not cause damage to either persons +or properties. + +9.2 The Licensor hereby represents, in good faith, that it is entitled +to grant all the rights over the Software (including in particular the +rights set forth in Article 5 <#scope>). + +9.3 The Licensee acknowledges that the Software is supplied "as is" by +the Licensor without any other express or tacit warranty, other than +that provided for in Article 9.2 <#good-faith> and, in particular, +without any warranty as to its commercial value, its secured, safe, +innovative or relevant nature. + +Specifically, the Licensor does not warrant that the Software is free +from any error, that it will operate without interruption, that it will +be compatible with the Licensee's own equipment and software +configuration, nor that it will meet the Licensee's requirements. + +9.4 The Licensor does not either expressly or tacitly warrant that the +Software does not infringe any third party intellectual property right +relating to a patent, software or any other property right. Therefore, +the Licensor disclaims any and all liability towards the Licensee +arising out of any or all proceedings for infringement that may be +instituted in respect of the use, modification and redistribution of the +Software. Nevertheless, should such proceedings be instituted against +the Licensee, the Licensor shall provide it with technical and legal +expertise for its defense. Such technical and legal expertise shall be +decided on a case-by-case basis between the relevant Licensor and the +Licensee pursuant to a memorandum of understanding. The Licensor +disclaims any and all liability as regards the Licensee's use of the +name of the Software. No warranty is given as regards the existence of +prior rights over the name of the Software or as regards the existence +of a trademark. + + + Article 10 - TERMINATION + +10.1 In the event of a breach by the Licensee of its obligations +hereunder, the Licensor may automatically terminate this Agreement +thirty (30) days after notice has been sent to the Licensee and has +remained ineffective. + +10.2 A Licensee whose Agreement is terminated shall no longer be +authorized to use, modify or distribute the Software. However, any +licenses that it may have granted prior to termination of the Agreement +shall remain valid subject to their having been granted in compliance +with the terms and conditions hereof. + + + Article 11 - MISCELLANEOUS + + + 11.1 EXCUSABLE EVENTS + +Neither Party shall be liable for any or all delay, or failure to +perform the Agreement, that may be attributable to an event of force +majeure, an act of God or an outside cause, such as defective +functioning or interruptions of the electricity or telecommunications +networks, network paralysis following a virus attack, intervention by +government authorities, natural disasters, water damage, earthquakes, +fire, explosions, strikes and labor unrest, war, etc. + +11.2 Any failure by either Party, on one or more occasions, to invoke +one or more of the provisions hereof, shall under no circumstances be +interpreted as being a waiver by the interested Party of its right to +invoke said provision(s) subsequently. + +11.3 The Agreement cancels and replaces any or all previous agreements, +whether written or oral, between the Parties and having the same +purpose, and constitutes the entirety of the agreement between said +Parties concerning said purpose. No supplement or modification to the +terms and conditions hereof shall be effective as between the Parties +unless it is made in writing and signed by their duly authorized +representatives. + +11.4 In the event that one or more of the provisions hereof were to +conflict with a current or future applicable act or legislative text, +said act or legislative text shall prevail, and the Parties shall make +the necessary amendments so as to comply with said act or legislative +text. All other provisions shall remain effective. Similarly, invalidity +of a provision of the Agreement, for any reason whatsoever, shall not +cause the Agreement as a whole to be invalid. + + + 11.5 LANGUAGE + +The Agreement is drafted in both French and English and both versions +are deemed authentic. + + + Article 12 - NEW VERSIONS OF THE AGREEMENT + +12.1 Any person is authorized to duplicate and distribute copies of this +Agreement. + +12.2 So as to ensure coherence, the wording of this Agreement is +protected and may only be modified by the authors of the License, who +reserve the right to periodically publish updates or new versions of the +Agreement, each with a separate number. These subsequent versions may +address new issues encountered by Free Software. + +12.3 Any Software distributed under a given version of the Agreement may +only be subsequently distributed under the same version of the Agreement +or a subsequent version, subject to the provisions of Article 5.3.4 +<#compatibility>. + + + Article 13 - GOVERNING LAW AND JURISDICTION + +13.1 The Agreement is governed by French law. The Parties agree to +endeavor to seek an amicable solution to any disagreements or disputes +that may arise during the performance of the Agreement. + +13.2 Failing an amicable solution within two (2) months as from their +occurrence, and unless emergency proceedings are necessary, the +disagreements or disputes shall be referred to the Paris Courts having +jurisdiction, by the more diligent Party. diff -r 000000000000 -r 059eb452931e README.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,58 @@ +Checking the formats of the dataMatrix, sampleMetadata, and variableMetadata files +================================================================================== + +A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure + +Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/checkformat.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/checkformat). + +### Description + +**Version:** 2.0.4 +**Date:** 2016-07-29 +**Author:** Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team) +**Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr) +**Citation:** Thevenot E.A., Roux A., Xu Y., Ezan E. and Junot C. (2015). Analysis of the human adult urinary metabolome variations with age, body mass index and gender by implementing a comprehensive workflow for univariate and OPLS statistical analyses. *Journal of Proteome Research*, **14**:3322-3335. [doi:10.1021/acs.jproteome.5b00354](http://dx.doi.org/10.1021/acs.jproteome.5b00354) +**Licence:** CeCILL +**Reference histories:** +[W4M00001a_sacurine-subset-statistics](http://galaxy.workflow4metabolomics.org/history/list_published), [W4M00001b_sacurine_complete](http://galaxy.workflow4metabolomics.org/history/list_published), +[W4M00002_sacurine_mtbls2](http://galaxy.workflow4metabolomics.org/history/list_published), [W4M00003_sacurine_diaplasma](http://galaxy.workflow4metabolomics.org/history/list_published) +**Funding:** Agence Nationale de la Recherche ([MetaboHUB](http://www.metabohub.fr/index.php?lang=en&Itemid=473) national infrastructure for metabolomics and fluxomics, ANR-11-INBS-0010 grant) + +### Installation + +* Configuration file: `checkformat_config.xml` +* Image file: `static/images/checkformat_workflowPositionImage.png` +* Wrapper file: `checkformat_wrapper.R` +* R packages + + **batch** from CRAN + + ```r + install.packages("batch", dep=TRUE) + ``` + +### Tests + +The code in the wrapper can be tested by running the `runit/checkformat_tests.R` R file + +You will need to install **RUnit** package in order to make it run: +```r +install.packages('RUnit', dependencies = TRUE) +``` + +### Working example + +See the **W4M00001a_sacurine-subset-statistics**, **W4M00001b_sacurine-complete**, **W4M00002_mtbls2**, or **W4M00003_diaplasma** shared histories in the **Shared Data/Published Histories** menu (https://galaxy.workflow4metabolomics.org/history/list_published) + +### News + +##### CHANGES IN VERSION 2.0.4 + +INTERNAL MODIFICATION + + * Minor internal modifications + +##### CHANGES IN VERSION 2.0.2 + +INTERNAL MODIFICATION + + * Creating tests for R code \ No newline at end of file diff -r 000000000000 -r 059eb452931e build.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/build.xml Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff -r 000000000000 -r 059eb452931e checkformat_config.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/checkformat_config.xml Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,224 @@ + + Checks the formats of the dataMatrix, sampleMetadata, and variableMetadata files + + + r-batch + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +.. class:: infomark + +**Author** Etienne Thevenot (W4M Core Development Team, MetaboHUB Paris, CEA) + +--------------------------------------------------- + +.. class:: infomark + +**Tool updates** + +See the **NEWS** section at the bottom of this page + +--------------------------------------------------- + +======================== +Check Format +======================== + +----------- +Description +----------- + +| Checks the format (row and column names) of the dataMatrix, sampleMetadata and variableMetadata tables + + +----------------- +Workflow position +----------------- + +.. image:: ./static/images/checkFormat_workflowPositionImage.png +:width: 600 + + + +----------- +Input files +----------- + ++----------------------------+---------+ +| Parameter : num + label | Format | ++============================+=========+ +| 1 : Data matrix file | tabular | ++----------------------------+---------+ +| 2 : Sample metadata file | tabular | ++----------------------------+---------+ +| 3 : Variable metadata file | tabular | ++----------------------------+---------+ + +| +| **Required formats for the dataMatrix, sampleMetadata, and variableMetadata files are** +| **described in the HowTo entitled 'Format Data For Postprocessing' available on the** +| **main page of Workflow4Metabolomics.org** +| + +------------ +Output files +------------ + +information.txt +| Text file with all messages when error(s) in formats are detected +| + +--------------------------------------------------- + +--------------- +Working example +--------------- + +.. class:: infomark + +See the **W4M00001a_sacurine-subset-statistics**, **W4M00001b_sacurine-complete**, **W4M00002_mtbls2**, or **W4M00003_diaplasma** shared histories in the **Shared Data/Published Histories** menu (https://galaxy.workflow4metabolomics.org/history/list_published) + +--------------------------------------------------- + +---- +NEWS +---- + +CHANGES IN VERSION 2.0.4 +======================== + +INTERNAL MODIFICATIONS + +Minor internal modifications + +CHANGES IN VERSION 2.0.2 +======================== + +INTERNAL MODIFICATIONS + +Test for R code +Planemo running validation +Planemo installing validation +Travis automated testing +Toolshed export + + + + + @Article{Thevenot2015, + Title = {Analysis of the human adult urinary metabolome variations with age, body mass index and gender by implementing a comprehensive workflow for univariate and OPLS statistical analyses}, + Author = {Thévenot, Etienne A. and Roux, Aurélie and Xu, Ying and Ezan, Eric and Junot, Christophe}, + Journal = {Journal of Proteome Research}, + Year = {2015}, + Note = {PMID: 26088811}, + Number = {8}, + Pages = {3322-3335}, + Volume = {14}, + + Doi = {10.1021/acs.jproteome.5b00354}, + Url = {http://pubs.acs.org/doi/full/10.1021/acs.jproteome.5b00354} + } + 10.1093/bioinformatics/btu813 + + + + diff -r 000000000000 -r 059eb452931e checkformat_script.R --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/checkformat_script.R Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,186 @@ +## Etienne Thevenot +## CEA, MetaboHUB Paris +## etienne.thevenot@cea.fr + + +## Reads the dataMatrix, sampleMetadata, and variableMetadata .tsv files +## and checks the formats +readAndCheckF <- function(datFilC="dataMatrix.tsv", + samFilC="sampleMetadata.tsv", + varFilC="variableMetadata.tsv") { + + ## options + + optStrAsFacL <- options()[["stringsAsFactors"]] + options(stringsAsFactors = FALSE) + + ## checking that the tables have no duplicated row or column names + + for(tabC in c("dat", "sam", "var")) { + + tabNamC <- switch(tabC, dat="dataMatrix", sam="sampleMetadata", var="variableMetadata") + + rowVc <- read.table(eval(parse(text=paste0(tabC, "FilC"))), + check.names = FALSE, + header = TRUE, + sep = "\t")[, 1] + + colVc <- unlist(read.table(eval(parse(text=paste0(tabC, "FilC"))), + check.names = FALSE, + nrow=1, + sep = "\t"))[-1] + + if(any(duplicated(rowVc))) + stop("The following row name(s) is/are duplicated in the ", + tabNamC, + " table: '", + paste(rowVc[duplicated(rowVc)], collapse="', '"), "'", + call.=FALSE) + + if(any(duplicated(colVc))) + stop("The following column name(s) is/are duplicated in the ", + tabNamC, + " table: '", + paste(colVc[duplicated(colVc)], collapse="', '"), "'", + call.=FALSE) + + rowMakVc <- make.names(rowVc, unique = TRUE) + + rowDifVl <- rowVc != rowMakVc + + if(any(rowDifVl)) { + rowDifDF <- data.frame(row = 1:length(rowVc), + actual = rowVc, + preferred = rowMakVc) + rowDifDF <- rowDifDF[rowDifVl, , drop = FALSE] + cat("\n\nWarning: The following row names of the ", + tabNamC, + " table are not in the standard R format, which may result in errors when loading the data in some of the W4M modules:\n", sep="") + print(rowDifDF) + } + + colMakVc <- make.names(colVc, unique = TRUE) + + colDifVl <- colVc != colMakVc + + if(any(colDifVl)) { + colDifDF <- data.frame(col = 1:length(colVc), + actual = colVc, + preferred = colMakVc) + colDifDF <- colDifDF[colDifVl, , drop = FALSE] + cat("\n\nWarning: The following column names of the ", + tabNamC, + " table are not in the standard R format, which may result in errors when loading the data in some of the W4M modules:\n", sep="") + print(colDifDF) + } + } + + ## reading tables + + datMN <- t(as.matrix(read.table(datFilC, + check.names = FALSE, + header = TRUE, + row.names = 1, + sep = "\t"))) + + samDF <- read.table(samFilC, + check.names = FALSE, + header = TRUE, + row.names = 1, + sep = "\t") + + varDF <- read.table(varFilC, + check.names = FALSE, + header = TRUE, + row.names = 1, + sep = "\t") + + ## checking formats + + chkL <- TRUE + + if(!identical(rownames(datMN), rownames(samDF))) { + ## checking sample names + + chkL <- FALSE + + datSamDifVc <- setdiff(rownames(datMN), rownames(samDF)) + + if(length(datSamDifVc)) { + cat("\nThe following samples were found in the dataMatrix column names but not in the sampleMetadata row names:\n", sep="") + print(cbind.data.frame(col = as.numeric(sapply(datSamDifVc, function(samC) which(rownames(datMN) == samC))), + name = datSamDifVc)) + } + + samDatDifVc <- setdiff(rownames(samDF), rownames(datMN)) + + if(length(samDatDifVc)) { + cat("\n\nThe following samples were found in the sampleMetadata row names but not in the dataMatrix column names:\n", sep="") + print(cbind.data.frame(row = as.numeric(sapply(samDatDifVc, function(samC) which(rownames(samDF) == samC))), + name = samDatDifVc)) + } + + if(nrow(datMN) != nrow(samDF)) { + cat("\n\nThe dataMatrix has ", nrow(datMN), " columns (ie samples) whereas the sampleMetadata has ", nrow(samDF), " rows\n", sep="") + } else if(identical(gsub("^X", "", rownames(datMN)), rownames(samDF))) { + cat("\n\nThe dataMatrix column names start with an 'X' but not the sampleMetadata row names\n", sep="") + } else if(identical(gsub("^X", "", rownames(samDF)), rownames(datMN))) { + cat("\n\nThe sampleMetadata row names start with an 'X' but not the dataMatrix column names\n", sep="") + } else if(identical(sort(rownames(datMN)), sort(rownames(samDF)))) { + cat("\n\nThe dataMatrix column names and the sampleMetadata row names are not in the same order:\n", sep="") + print(cbind.data.frame(indice = 1:nrow(datMN), + dataMatrix_columnnames=rownames(datMN), + sampleMetadata_rownames=rownames(samDF))[rownames(datMN) != rownames(samDF), , drop = FALSE]) + } else { + cat("\n\nThe dataMatrix column names and the sampleMetadata row names are not identical:\n", sep="") + print(cbind.data.frame(indice = 1:nrow(datMN), + dataMatrix_columnnames=rownames(datMN), + sampleMetadata_rownames=rownames(samDF))[rownames(datMN) != rownames(samDF), , drop = FALSE]) + } + + } + + if(!identical(colnames(datMN), rownames(varDF))) { + ## checking variable names + + chkL <- FALSE + + datVarDifVc <- setdiff(colnames(datMN), rownames(varDF)) + + if(length(datVarDifVc)) { + cat("\nThe following variables were found in the dataMatrix row names but not in the variableMetadata row names:\n", sep="") + print(cbind.data.frame(row = as.numeric(sapply(datVarDifVc, function(varC) which(colnames(datMN) == varC))), + name = datVarDifVc)) + + } + + varDatDifVc <- setdiff(rownames(varDF), colnames(datMN)) + + if(length(varDatDifVc)) { + cat("\n\nThe following variables were found in the variableMetadata row names but not in the dataMatrix row names:\n", sep="") + print(cbind.data.frame(row = as.numeric(sapply(varDatDifVc, function(varC) which(rownames(varDF) == varC))), + name = varDatDifVc)) + } + + if(ncol(datMN) != nrow(varDF)) { + cat("\n\nThe dataMatrix has ", nrow(datMN), " rows (ie variables) whereas the variableMetadata has ", nrow(varDF), " rows\n", sep="") + } else if(identical(sort(colnames(datMN)), sort(rownames(varDF)))) { + cat("\n\nThe dataMatrix row names and the variableMetadata row names are not in the same order:\n", sep="") + print(cbind.data.frame(row = 1:ncol(datMN), + dataMatrix_rownames=colnames(datMN), + variableMetadata_rownames=rownames(varDF))[colnames(datMN) != rownames(varDF), , drop = FALSE]) + } else { + cat("\n\nThe dataMatrix row names and the variableMetadata row names are not identical:\n", sep="") + print(cbind.data.frame(row = 1:ncol(datMN), + dataMatrix_rownames=colnames(datMN), + variableMetadata_rownames=rownames(varDF))[colnames(datMN) != rownames(varDF), , drop = FALSE]) + } + } + + options(stringsAsFactors=optStrAsFacL) + + resLs <- list(chkL=chkL) + + return(resLs) + +} ## end of checkAndReadF diff -r 000000000000 -r 059eb452931e checkformat_wrapper.R --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/checkformat_wrapper.R Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,107 @@ +#!/usr/bin/env Rscript + +library(batch) ## parseCommandArgs + +source_local <- function(fname){ + argv <- commandArgs(trailingOnly = FALSE) + base_dir <- dirname(substring(argv[grep("--file=", argv)], 8)) + source(paste(base_dir, fname, sep="/")) +} + +source_local("checkformat_script.R") + +argVc <- unlist(parseCommandArgs(evaluate = FALSE)) + + +##------------------------------ +## Initializing +##------------------------------ + +## options +##-------- + +strAsFacL <- options()$stringsAsFactors +options(stringsAsFactors = FALSE) + +## constants +##---------- + +modNamC <- "Check Format" ## module name + +## log file +##--------- + +sink(argVc["information"]) + +cat("\nStart of the '", modNamC, "' Galaxy module call: ", + format(Sys.time(), "%a %d %b %Y %X"), "\n", sep="") + + +##------------------------------ +## Computation +##------------------------------ + + +resLs <- readAndCheckF(argVc["dataMatrix_in"], + argVc["sampleMetadata_in"], + argVc["variableMetadata_in"]) +chkL <- resLs[["chkL"]] + + +##------------------------------ +## Ending +##------------------------------ + + +if(chkL) { + + cat("\nTable formats are OK; enjoy your analyses!\n", sep="") + + cat("\nEnd of the '", modNamC, "' Galaxy module call: ", + format(Sys.time(), "%a %d %b %Y %X"), "\n", sep="") + + cat("\n\n\n============================================================================") + cat("\nAdditional information about the call:\n") + cat("\n1) Parameters:\n") + print(cbind(value = argVc)) + + cat("\n2) Session Info:\n") + sessioninfo <- sessionInfo() + cat(sessioninfo$R.version$version.string,"\n") + cat("Main packages:\n") + for (pkg in names(sessioninfo$otherPkgs)) { cat(paste(pkg,packageVersion(pkg)),"\t") }; cat("\n") + cat("Other loaded packages:\n") + for (pkg in names(sessioninfo$loadedOnly)) { cat(paste(pkg,packageVersion(pkg)),"\t") }; cat("\n") + + cat("============================================================================\n") + + sink() + +} else { + + cat("\n\n\n============================================================================") + cat("\nAdditional information about the call:\n") + cat("\n1) Parameters:\n") + print(cbind(value = argVc)) + + cat("\n2) Session Info:\n") + sessioninfo <- sessionInfo() + cat(sessioninfo$R.version$version.string,"\n") + cat("Main packages:\n") + for (pkg in names(sessioninfo$otherPkgs)) { cat(paste(pkg,packageVersion(pkg)),"\t") }; cat("\n") + cat("Other loaded packages:\n") + for (pkg in names(sessioninfo$loadedOnly)) { cat(paste(pkg,packageVersion(pkg)),"\t") }; cat("\n") + + cat("============================================================================\n") + + sink() + stop("Please check the generated 'information' file") + +} + +## closing +##-------- + +options(stringsAsFactors = strAsFacL) + +rm(list = ls()) diff -r 000000000000 -r 059eb452931e runit/.Rhistory --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/.Rhistory Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,1 @@ +q("no") diff -r 000000000000 -r 059eb452931e runit/checkformat_runtests.R --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/checkformat_runtests.R Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,101 @@ +#!/usr/bin/env Rscript + +## Package +##-------- + +library(RUnit) + +## Constants +##---------- + +testOutDirC <- "output" +argVc <- commandArgs(trailingOnly = FALSE) +scriptPathC <- sub("--file=", "", argVc[grep("--file=", argVc)]) + + +## Functions +##----------- + +## Reading tables (matrix or data frame) +readTableF <- function(fileC, typeC = c("matrix", "dataframe")[1]) { + + file.exists(fileC) || stop(paste0("No output file \"", fileC ,"\".")) + + switch(typeC, + matrix = return(t(as.matrix(read.table(file = fileC, + header = TRUE, + row.names = 1, + sep = "\t", + stringsAsFactors = FALSE)))), + dataframe = return(read.table(file = fileC, + header = TRUE, + row.names = 1, + sep = "\t", + stringsAsFactors = FALSE))) + +} + +## Call wrapper +wrapperCallF <- function(paramLs) { + + ## Set program path + wrapperPathC <- file.path(dirname(scriptPathC), "..", "checkformat_wrapper.R") + + ## Set arguments + argLs <- NULL + for (parC in names(paramLs)) + argLs <- c(argLs, parC, paramLs[[parC]]) + + ## Call + wrapperCallC <- paste(c(wrapperPathC, argLs), collapse = " ") + + if(.Platform$OS.type == "windows") + wrapperCallC <- paste("Rscript", wrapperCallC) + + wrapperCodeN <- system(wrapperCallC) + + if (wrapperCodeN != 0) + stop("Error when running checkformat_wrapper.R.") + + ## Get output + outLs <- list() + if ("dataMatrix_out" %in% names(paramLs)) + outLs[["datMN"]] <- readTableF(paramLs[["dataMatrix_out"]], "matrix") + if ("sampleMetadata_out" %in% names(paramLs)) + outLs[["samDF"]] <- readTableF(paramLs[["sampleMetadata_out"]], "dataframe") + if ("variableMetadata_out" %in% names(paramLs)) + outLs[["varDF"]] <- readTableF(paramLs[["variableMetadata_out"]], "dataframe") + if("information" %in% names(paramLs)) + outLs[["infVc"]] <- readLines(paramLs[["information"]]) + + return(outLs) +} + +## Setting default parameters +defaultArgF <- function(testInDirC) { + + defaultArgLs <- list() + if(file.exists(file.path(dirname(scriptPathC), testInDirC, "dataMatrix.tsv"))) + defaultArgLs[["dataMatrix_in"]] <- file.path(dirname(scriptPathC), testInDirC, "dataMatrix.tsv") + if(file.exists(file.path(dirname(scriptPathC), testInDirC, "sampleMetadata.tsv"))) + defaultArgLs[["sampleMetadata_in"]] <- file.path(dirname(scriptPathC), testInDirC, "sampleMetadata.tsv") + if(file.exists(file.path(dirname(scriptPathC), testInDirC, "variableMetadata.tsv"))) + defaultArgLs[["variableMetadata_in"]] <- file.path(dirname(scriptPathC), testInDirC, "variableMetadata.tsv") + + defaultArgLs[["information"]] <- file.path(dirname(scriptPathC), testOutDirC, "information.txt") + + defaultArgLs + +} + +## Main +##----- + +## Create output folder +file.exists(testOutDirC) || dir.create(testOutDirC) + +## Run tests +test.suite <- defineTestSuite('tests', dirname(scriptPathC), testFileRegexp = paste0('^.*_tests\\.R$'), testFuncRegexp = '^.*$') +isValidTestSuite(test.suite) +test.results <- runTestSuite(test.suite) +print(test.results) diff -r 000000000000 -r 059eb452931e runit/checkformat_tests.R --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/checkformat_tests.R Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,11 @@ +test_input_default <- function() { + + testDirC <- "input" + argLs <- list() + + argLs <- c(defaultArgF(testDirC), argLs) + outLs <- wrapperCallF(argLs) + + checkEquals(outLs[['infVc']][4], 'Table formats are OK; enjoy your analyses!') + +} diff -r 000000000000 -r 059eb452931e runit/input/dataMatrix.tsv --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/input/dataMatrix.tsv Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,4 @@ +dataMatrix HU_017 HU_021 HU_027 HU_032 HU_041 HU_048 HU_049 HU_050 HU_052 HU_059 HU_060 HU_066 HU_072 HU_077 HU_090 HU_109 HU_110 HU_125 HU_126 HU_131 HU_134 HU_149 HU_150 HU_173 HU_179 HU_180 HU_182 HU_202 HU_204 HU_209 +HMDB01032 2569204.924 6222035.774 17070707.99 1258838.243 13039543.08 1909391.77 3495.093864 2293521.909 128503.2751 81872.52764 8103557.566 149574887 1544036.41 7103429.539 14138796.5 4970265.58 263054.7306 1671332.3 88433.1945 23602331.29 18648126.52 1554657.988 34152.36464 209372.7128 33187733.37 202438.5916 13581070.09 354170.8107 9120781.49 43419175.41 +HMDB03072 3628416.303 65626.98344 112170.1189 3261804.344 42228.27877 343254.2013 1958217.693 11983270.04 5932111.416 5511385.834 9154521.478 2632133.212 9500411.146 6551644.517 7204319.809 1273412.048 3260583.816 8932005.535 8340827.526 9256460.692 11217839.17 5919262.814 11790077.07 9567977.808 73717.58117 9991787.291 4208098.147 623970.6499 10904221.26 2171793.936 +HMDB00792 429568.6094 3887629.505 1330692.117 1367446.73 844197.4475 2948090.719 1614157.906 3740009.194 3292251.665 2310688.795 4404239.59 3043289.128 825736.4672 2523241.917 6030501.026 474901.6041 2885792.426 2955990.64 1917716.343 1767962.677 5926203.404 1639065.695 346810.7636 1054776.223 2390258.275 1831346.373 1026696.369 7079792.5 4368341.014 3495986.873 diff -r 000000000000 -r 059eb452931e runit/input/sampleMetadata.tsv --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/input/sampleMetadata.tsv Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,31 @@ +sampleMetadata age ageGrp +HU_017 41 experienced +HU_021 34 junior +HU_027 37 experienced +HU_032 38 experienced +HU_041 28 junior +HU_048 39 experienced +HU_049 50 senior +HU_050 30 junior +HU_052 51 senior +HU_059 81 senior +HU_060 55 senior +HU_066 25 junior +HU_072 47 experienced +HU_077 27 junior +HU_090 46 experienced +HU_109 32 junior +HU_110 50 senior +HU_125 58 senior +HU_126 45 experienced +HU_131 42 experienced +HU_134 48 experienced +HU_149 35 experienced +HU_150 49 experienced +HU_173 55 senior +HU_179 33 junior +HU_180 53 senior +HU_182 43 experienced +HU_202 42 experienced +HU_204 31 junior +HU_209 17.5 junior diff -r 000000000000 -r 059eb452931e runit/input/variableMetadata.tsv --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/input/variableMetadata.tsv Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,4 @@ +variableMetadata name +HMDB01032 Dehydroepiandrosterone sulfate +HMDB03072 Quinic acid +HMDB00792 Sebacic acid diff -r 000000000000 -r 059eb452931e runit/output/information.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/runit/output/information.txt Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,6 @@ + +Start of the 'Check Format' Galaxy module call: Thu 04 Aug 2016 09:29:19 PM + +Table formats are OK; enjoy your analyses! + +End of the 'Check Format' Galaxy module call: Thu 04 Aug 2016 09:29:19 PM diff -r 000000000000 -r 059eb452931e static/images/checkFormat_workflowPositionImage.png Binary file static/images/checkFormat_workflowPositionImage.png has changed diff -r 000000000000 -r 059eb452931e test-data/input-dataMatrix.tsv --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test-data/input-dataMatrix.tsv Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,4 @@ +dataMatrix HU_017 HU_021 HU_027 HU_032 HU_041 HU_048 HU_049 HU_050 HU_052 HU_059 HU_060 HU_066 HU_072 HU_077 HU_090 HU_109 HU_110 HU_125 HU_126 HU_131 HU_134 HU_149 HU_150 HU_173 HU_179 HU_180 HU_182 HU_202 HU_204 HU_209 +HMDB01032 2569204.924 6222035.774 17070707.99 1258838.243 13039543.08 1909391.77 3495.093864 2293521.909 128503.2751 81872.52764 8103557.566 149574887 1544036.41 7103429.539 14138796.5 4970265.58 263054.7306 1671332.3 88433.1945 23602331.29 18648126.52 1554657.988 34152.36464 209372.7128 33187733.37 202438.5916 13581070.09 354170.8107 9120781.49 43419175.41 +HMDB03072 3628416.303 65626.98344 112170.1189 3261804.344 42228.27877 343254.2013 1958217.693 11983270.04 5932111.416 5511385.834 9154521.478 2632133.212 9500411.146 6551644.517 7204319.809 1273412.048 3260583.816 8932005.535 8340827.526 9256460.692 11217839.17 5919262.814 11790077.07 9567977.808 73717.58117 9991787.291 4208098.147 623970.6499 10904221.26 2171793.936 +HMDB00792 429568.6094 3887629.505 1330692.117 1367446.73 844197.4475 2948090.719 1614157.906 3740009.194 3292251.665 2310688.795 4404239.59 3043289.128 825736.4672 2523241.917 6030501.026 474901.6041 2885792.426 2955990.64 1917716.343 1767962.677 5926203.404 1639065.695 346810.7636 1054776.223 2390258.275 1831346.373 1026696.369 7079792.5 4368341.014 3495986.873 diff -r 000000000000 -r 059eb452931e test-data/input-sampleMetadata.tsv --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test-data/input-sampleMetadata.tsv Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,31 @@ +sampleMetadata age ageGrp +HU_017 41 experienced +HU_021 34 junior +HU_027 37 experienced +HU_032 38 experienced +HU_041 28 junior +HU_048 39 experienced +HU_049 50 senior +HU_050 30 junior +HU_052 51 senior +HU_059 81 senior +HU_060 55 senior +HU_066 25 junior +HU_072 47 experienced +HU_077 27 junior +HU_090 46 experienced +HU_109 32 junior +HU_110 50 senior +HU_125 58 senior +HU_126 45 experienced +HU_131 42 experienced +HU_134 48 experienced +HU_149 35 experienced +HU_150 49 experienced +HU_173 55 senior +HU_179 33 junior +HU_180 53 senior +HU_182 43 experienced +HU_202 42 experienced +HU_204 31 junior +HU_209 17.5 junior diff -r 000000000000 -r 059eb452931e test-data/input-variableMetadata.tsv --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test-data/input-variableMetadata.tsv Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,4 @@ +variableMetadata name +HMDB01032 Dehydroepiandrosterone sulfate +HMDB03072 Quinic acid +HMDB00792 Sebacic acid diff -r 000000000000 -r 059eb452931e test-data/output-information.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test-data/output-information.txt Tue Oct 24 08:44:02 2017 -0400 @@ -0,0 +1,6 @@ + +Start of the 'Check Format' Galaxy module call: Sat 30 Jul 2016 07:49:51 AM + +Table formats are OK; enjoy your analyses! + +End of the 'Check Format' Galaxy module call: Sat 30 Jul 2016 07:49:51 AM