annotate readme.txt @ 2:59907c23e75e draft

Uploaded
author geoffrey.dintilhac
date Sat, 11 Jan 2020 12:23:57 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
1
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
2 ===========================
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
3 Galaxy wrapper for bamtobed
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
4 ===========================
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
5
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
6 This wrapper is made by ALIS Marine and DINTILHAC Geoffrey, 2019.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
7 Version 0.1.0.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
8
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
9
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
10 Manual Installation
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
11 ===================
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
12
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
13 To use bamtobed tool please follow these steps :
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
14
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
15 - Create a folder bamtobed in /galaxy/tools
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
16
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
17 - Add the files "bamtobed.py" (Galaxy tool definition), "bamtobed.xml" (wrapper tool) and "readme.rst" in this folder
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
18
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
19 - In order to tell Galaxy this tool exists, a modification is needed, in the folder /galaxy/config :
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
20 * In the "tools_conf.xml" file, under the section "Convert Formats" (line :``<section id="convert" name="Convert Formats">``) add the line :
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
21 <tool file="bamtobed_project/bamtobed.xml" />
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
22
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
23 * Or if you rather add it in a new section, add (after all the sections) :
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
24 <section name="MyTools" id="mTools">
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
25 <tool file="bamtobed_project/bamtobed.xml" />
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
26 </section>
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
27
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
28
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
29 If you want to run the tests :
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
30 $ ./run_tests.sh -id bamtobed_project
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
31
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
32 This wrapper is available from the Galaxy Tool Shed at:
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
33 https://toolshed.g2.bx.psu.edu/view/geoffrey.dintilhac/bam_to_bed/68f7b5a4b1e2
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
34
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
35
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
36 What it does
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
37 ============
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
38
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
39 This tool converts sequence alignments in BAM format into BED, BED12 or BEDPE format running the command "bamtobed" of bedtools (version 2.29.0).
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
40 The bedtools utilities are a swiss-army knife of tools for a wide-range of genomics analysis tasks.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
41
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
42 For more informations about bamtobed command, please refer to this link : https://bedtools.readthedocs.io/en/latest/content/tools/bamtobed.html
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
43 For informations about BED and BEDPE format : https://bedtools.readthedocs.io/en/latest/content/general-usage.html
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
44
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
45 Warnings
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
46 ========
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
47 - If you want a BEDPE output, your input has to be paired-end and sorted by read name.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
48 - About score calculation : the option "another tag" is disallowed with BEDPE output.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
49 - About the options -split and -cigar :
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
50 * -split is disallowed with edit-distance as a calculation for BED score.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
51 * -cigar is not displayed with -splits, and disallowed with edit-distance as a calculation for BED score.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
52
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
53
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
54 MIT License
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
55 =============
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
56
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
57 Permission is hereby granted, free of charge, to any person obtaining
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
58 a copy of this software and associated documentation files (the
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
59 "Software"), to deal in the Software without restriction, including
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
60 without limitation the rights to use, copy, modify, merge, publish,
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
61 distribute, sublicense, and/or sell copies of the Software, and to
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
62 permit persons to whom the Software is furnished to do so, subject to
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
63 the following conditions:
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
64
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
65 The above copyright notice and this permission notice shall be
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
66 included in all copies or substantial portions of the Software.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
67
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
68 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
69 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
70 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
71 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
72 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
73 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
74 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
75 SOFTWARE
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
76
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
77 NOTE: This is the licence for the Galaxy Wrapper only.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
78 bedtools bamtobed is available and licenced separately.
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
79
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
80
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
81
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
82
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
83
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
84
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
85
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
86
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
87
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
88
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
89
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
90
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
91
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
92
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
93
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
94
59907c23e75e Uploaded
geoffrey.dintilhac
parents:
diff changeset
95