annotate README.md @ 0:c577f13705f2 draft default tip

planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
author workflow4metabolomics
date Wed, 10 Jul 2024 15:20:11 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
1 # W4M concatenate
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
2
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
3
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
4 Metadata
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
5 -----------
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
6
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
7 * **@name**: W4M concatenate
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
8 * **@galaxyID**: W4Mconcatenate
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
9 * **@version**: 1.0.0
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
10 * **@authors**: Original code: Hanane Nourine (Intern - PFEM - INRAE) - Maintainer: Melanie Petera (PFEM - INRAE - MetaboHUB)
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
11 * **@init date**: 2024, May
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
12 * **@main usage**: This tool enables the concatenation of two matrices of Metadata and returns a matrix of Metadata and two DataMatrix
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
13
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
14
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
15 Context
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
16 -----------
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
17
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
18 This tool is provided as one of the [Workflow4Metabolomics](http://workflow4metabolomics.org) Galaxy instance data handling tools.
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
19 W4M is an international infrastructure providing software tools to process, analyse and annotate metabolomics data.
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
20
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
21 User interface is based on the Galaxy platform (homepage: https://galaxyproject.org/). It is an open, web-based platform for data intensive biomedical research.
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
22 Whether on the free public server or your own instance, you can perform, reproduce, and share complete analyses.
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
23
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
24 The tool was created as part of a Master's level internship.
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
25
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
26 Configuration
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
27 -----------
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
28
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
29 ### Requirement:
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
30 * R software: version = 4.3.3 recommended
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
31 * r-dplyr = 1.1.4
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
32 * r-w4mrutils = 1.0.0
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
33
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
34 Technical description
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
35 -----------
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
36
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
37 Main files:
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
38
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
39 - concatenation.R: R function (core script)
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
40 - fonctions_auxiliaires.R : R auxiliary functions.
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
41 - concatenation_wrapper.R: R script to link the main R function to inputs
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
42 - concat.xml: XML wrapper (interface for Galaxy)
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
43
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
44
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
45 Services provided
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
46 -----------
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
47
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
48 * Help and support: https://community.france-bioinformatique.fr/c/workflow4metabolomics/10
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
49
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
50
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
51
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
52 License
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
53 -----------
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
54
c577f13705f2 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics commit eba1150dad55ad9eca5e93358d9f75e6b6dba2ec
workflow4metabolomics
parents:
diff changeset
55 * Cea Cnrs Inria Logiciel Libre License, version 2.1 (CECILL-2.1)