annotate fastx_barcode_splitter_galaxy_wrapper.sh @ 5:80e84db1c392 draft

planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
author lparsons
date Thu, 22 Oct 2015 15:40:57 -0400
parents d1a0e6201854
children 51e098891465
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
1 #!/bin/bash
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
2
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
3 # FASTX-toolkit - FASTA/FASTQ preprocessing tools.
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
4 # Copyright (C) 2009 A. Gordon (gordon@cshl.edu)
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
5 #
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
6 # This program is free software: you can redistribute it and/or modify
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
7 # it under the terms of the GNU Affero General Public License as
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
8 # published by the Free Software Foundation, either version 3 of the
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
9 # License, or (at your option) any later version.
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
10 #
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
11 # This program is distributed in the hope that it will be useful,
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
14 # GNU Affero General Public License for more details.
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
15 #
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
18
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
19 # Modified by Lance Parsons (lparsons@princeton.edu)
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
20 # 2011-03-15 Adapted to allow galaxy to determine filetype
5
80e84db1c392 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
lparsons
parents: 4
diff changeset
21 # 2015-10-21 Updated to make compatible with OSX (BSD sed)
4
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
22 #
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
23 #This is a shell script wrapper for 'fastx_barcode_splitter.pl'
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
24 #
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
25 # 1. Output files are saved at the dataset's files_path directory.
5
80e84db1c392 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
lparsons
parents: 4
diff changeset
26 #
4
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
27 # 2. 'fastx_barcode_splitter.pl' outputs a textual table.
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
28 # This script turns it into pretty HTML with working URL
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
29 # (so lazy users can just click on the URLs and get their files)
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
30
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
31 if [ "$1x" = "x" ]; then
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
32 echo "Usage: $0 [BARCODE FILE] [FASTQ FILE] [LIBRARY_NAME] [OUTPUT_PATH] [FILETYPE]" >&2
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
33 exit 1
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
34 fi
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
35
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
36 BARCODE_FILE="$1"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
37 FASTQ_FILE="$2"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
38 LIBNAME="$3"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
39 OUTPUT_PATH="$4"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
40 FILETYPE="$5"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
41 shift 5
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
42 # The rest of the parameters are passed to the split program
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
43
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
44 if [ "${OUTPUT_PATH}x" = "x" ]; then
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
45 echo "Usage: $0 [BARCODE FILE] [FASTQ FILE] [LIBRARY_NAME] [OUTPUT_PATH] [FILETYPE]" >&2
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
46 exit 1
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
47 fi
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
48
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
49 #Sanitize library name, make sure we can create a file with this name
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
50 LIBNAME=${LIBNAME%.gz}
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
51 LIBNAME=${LIBNAME%.txt}
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
52 LIBNAME=$(echo "$LIBNAME" | tr -cd '[:alnum:]_')
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
53
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
54 if [ ! -r "$FASTQ_FILE" ]; then
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
55 echo "Error: Input file ($FASTQ_FILE) not found!" >&2
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
56 exit 1
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
57 fi
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
58 if [ ! -r "$BARCODE_FILE" ]; then
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
59 echo "Error: barcode file ($BARCODE_FILE) not found!" >&2
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
60 exit 1
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
61 fi
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
62 mkdir -p "$OUTPUT_PATH"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
63 if [ ! -d "$OUTPUT_PATH" ]; then
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
64 echo "Error: failed to create output path '$OUTPUT_PATH'" >&2
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
65 exit 1
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
66 fi
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
67
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
68 PUBLICURL=""
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
69 BASEPATH="$OUTPUT_PATH/"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
70 #PREFIX="$BASEPATH"`date "+%Y-%m-%d_%H%M__"`"${LIBNAME}__"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
71 PREFIX="$BASEPATH""${LIBNAME}_"
5
80e84db1c392 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
lparsons
parents: 4
diff changeset
72 SUFFIX="_visible.$FILETYPE"
4
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
73 DIRECTORY=$(cd `dirname $0` && pwd)
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
74
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
75 RESULTS=`gzip -cdf "$FASTQ_FILE" | $DIRECTORY/fastx_barcode_splitter.pl --bcfile "$BARCODE_FILE" --prefix "$PREFIX" --suffix "$SUFFIX" "$@"`
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
76 if [ $? != 0 ]; then
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
77 echo "error"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
78 fi
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
79
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
80 #
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
81 # Convert the textual tab-separated table into simple HTML table,
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
82 # with the local path replaces with a valid URL
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
83 #HTMLSUMMARY=${PREFIX}stats_visible_html
5
80e84db1c392 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
lparsons
parents: 4
diff changeset
84 echo "<html><body><table border=1>"
80e84db1c392 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
lparsons
parents: 4
diff changeset
85 echo "$RESULTS" | sed "s|$BASEPATH\\(.*\\)|<a href=\"\\1\">\\1<\\a>|" | \
80e84db1c392 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastx_barcode_splitter_enhanced commit 9ece31c748369db47d9817066cb91e6f3e8428c8-dirty
lparsons
parents: 4
diff changeset
86 perl -n -i -e '$_ =~ s|\t|</td><td>|g; print "<tr><td>\n$_</td></tr>\n"'
4
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
87 echo "<p>"
d1a0e6201854 Uploaded
lparsons
parents:
diff changeset
88 echo "</table></body></html>"