Intermediate commit of ObjectBuilderI and its implementation. Not
[bioperl-live.git] / bioscripts.pod
blob75e5258b2c7c23595674c25279b1c428b1ee7e61
1 =head1 NAME
3 Bioscripts
5 =head1 SYNOPSIS
7 A list of the scripts in Bioperl
9 =head1 DESCRIPTION
11 These scripts have been contributed by the developers and users of
12 Bioperl. They are organized into directories roughly mirroring those
13 in the Bioperl Bio directory. Please contact bioperl-l@bioperl.org if
14 you are interested in contributing your own script.
16 =head2 scripts/align/align_on_codons.pl
18 Aligns nucleotide sequences based on codons in a specified reading frame.
20 =head2 scripts/align/aligntutorial.pl
22 Examples using EMBOSS, pSW, Clustalw, TCoffee, and Blast to align sequences.
24 =head2 scripts/align/clustalw.pl
26 A demonstration of the various uses of Alignment::Clustalw. See 
27 L<Bio::Tools::Run::Alignment::Clustalw> for more.
29 =head2 scripts/align/simplealign.pl
31 A script that demonstrates some uses of AlignIO. Please see
32 L<Bio::AlignIO> for more information.
34 =head2 scripts/biblio/biblio.pl
36 A script that shows how to query bibliographic databases, such as
37 Medline, using ids, keywords, and other fields. See L<Bio::Biblio> for 
38 details.
40 =head2 scripts/biblio/biblio_soap.pl
42 Connect to and test a SOAP server using a Bio::Biblio object.
44 =head2 scripts/bioperl.pl
46 A Bioperl shell!
48 =head2 scripts/cluster/dbsnp.pl
50 How to parse a dbsnp XML file. See L<Bio::ClusterIO> for details.
52 =head2 scripts/contributed/nmrpdb_parse.pl
54 Extracts individual conformers from an NMR-derived PDB file.
56 =head2 scripts/contributed/prosite2perl.pl
58 Convert Prosite motifs to Perl regular expressions.
60 =head2 scripts/contributed/rebase2list.pl
62 Script to convert rebase file to format compatible with 
63 Bio::Tools::RestrictionEnzyme.
65 =head2 scripts/das/das_server.pl
67 Sets up a minimal DAS annotation server, requires Apache::DBI and
68 Bio::DB::GFF. See L<Bio::DB::GFF> for details.
70 =head2 scripts/db/dbfetch
72 Creates a Web page to query a local SRS server and fetch sequences.
74 =head2 scripts/db/est_tissue_query.pl
76 Fetch EST sequences from local files or Genbank filtered by tissue
77 using Bio::DB* or Bio::Index*.
79 =head2 scripts/db/flanks.pl
81 Fetch a sequence, find the sequences flanking a variant or SNP in the
82 sequence given its position.
84 =head2 scripts/db/gb2features.pl
86 Shows how to extract all the features from a Genbank file. See 
87 L<Bio::Seq> for more information on features.
89 =head2 scripts/db/getGenBank.pl
91 Retrieving Genbank entries over the Web using DB::GenBank. See
92 L<Bio::DB::GenBank> for more information.
94 =head2 scripts/db/get_seqs.pl
96 Fetches and formats sequences from GenBank, EMBL, or SwissProt over
97 the network using Bio::DB*.
99 =head2 scripts/db/gff/*
101 Scripts that reformat sequence to GFF and load GFF format files into
102 an indexed database - see L<Bio::DB::GFF> for more information.
104 =head2 scripts/db/rfetch.pl
106 A script that uses Bio::DB::Registry to retrieve sequences from EMBL,
107 reformat them, and print them. See L<Bio::DB::Registry>.
109 =head2 scripts/db/use_registry.pl
111 Script that shows how to use Bio::DB::Registry, part of Bioperl's
112 integration with OBDA, the Open Bio Database Access registry
113 scheme. See L<Bio::DB::Registry> for more information.
115 =head2 scripts/exceptions/*
117 Scripts that demonstrate how to throw and catch Error.pm objects.
119 =head2 scripts/generate_random_seq.pl
121 Writes random RNA, DNA, or protein sequence of given length.
123 =head2 scripts/graphics/feature_draw.pl
125 Script that accepts files in GFF or tab-delimited format and creates
126 corresponding PNG image files. See L<Bio::Graphics> and
127 L<Bio::Graphics::FeatureFile> for more information.
129 =head2 scripts/graphics/render_sequence.pl
131 This scripts fetchs a sequence from a remote database, extracts its
132 features (CDS, gene, tRNA), and creates a graphic representation of
133 the sequence in PNG or GIF format. See L<Bio::DB::BioFetch>
134 and L<Bio::Graphics>.
136 =head2 scripts/index/bpfetch.pl
138 Fetch sequences from local indexed database or over the network and
139 reformat using Bio::Index* and Bio::DB*.
141 =head2 scripts/index/bpindex.pl
143 Indexes local databases, partners with bpfetch.pl.
145 =head2 scripts/liveseq/change_gene.pl
147 A script showing how to use LiveSeq::Mutator and
148 LiveSeq::Mutation. Please see L<Bio::LiveSeq::Mutator> and 
149 L<Bio::LiveSeq::Mutation> for more information.
151 =head2 scripts/longorf.pl
153 A script that finds the longest ORF in one or more nucleotide sequences.
155 =head2 scripts/make_mrna_protein.pl
157 Translate a cDNA or ORF to protein using Bio::Seq's translate() method.
159 =head2 scripts/make_primers.pl
161 Design PCR primers given a sequence and the positions of the start and
162 stop codons in the sequence's ORF.
164 =head2 scripts/rev_and_trans.pl
166 Examples using Bio::Seq.pm for reversing and translating
167 sequences. See L<Bio::Seq> for more information.
169 =head2 scripts/revcom_dir.pl
171 Eeturn reverse complement sequences of all sequences in the current
172 directory and save them in the same directory.
174 =head2 scripts/root_object/*
176 Scripts that demonstrate uses of the Bio::Root modules.
178 =head2 scripts/root_object/vector/vector.pl
180 Script to test Bio::Root::Vector.
182 =head2 scripts/searchio/*
184 A number of scripts illustrating the use of Bio::SearchIO for parsing
185 Blast and PSI-Blast results. See L<Bio::SearchIO> for more information.
187 =head2 scripts/searchio/waba2gff.pl
189 Convert raw WABA output to one type of GFF.
191 =head2 scripts/seq/*
193 Example code for working with multiple sequence files, including
194 formatting, printing, and filtering based on length or description or ID.
196 =head2 scripts/seqstats/aacomp.pl
198 Calculate amino acid composition of a protein using Tools::CodonTable
199 and Tools::IUPAC. See L<Bio::Tools::IUPAC> and
200 L<Bio::Tools::CodonTable> for more information.
202 =head2 scripts/seqstats/chaos_plot.pl
204 Produce a PNG or JPEG chaos plot given a DNA sequence using GD.pm.
206 =head2 scripts/seqstats/gccalc.pl
208 Calculate %GC given a DNA sequence using Tools::SeqStats. See
209 L<Bio::Tools::SeqStats> for more information.
211 =head2 scripts/seqstats/oligo_count.pl
213 Calculates oligomer frequencies given an oligomer length and a sequence.
215 =head2 scripts/structure/struct_example*
217 Scripts that show how to examine details of the 3D structure of a
218 protein by parsing a PDB file. See L<Bio::Structure::IO> for more information.
220 =head2 scripts/subsequence.cgi
222 CGI script to fetch a sequence from Genbank and extract a subsequence
223 using DB::GenBank. See L<Bio::DB::GenBank>.
225 =head2 scripts/tk/gsequence
227 Create a Protein Sequence Control Panel GUI with Gtk.
229 =head2 scripts/tk/hitdisplay.pl
231 Create a GUI for displaying Blast results using Tk::HitDisplay.
232 Please see L<Bio::Tk::HitDisplay> for more information.
234 =head2 scripts/tools/gb_to_gff.pl
236 Extracts top-level sequence features from Genbank-formatted sequence
237 files using Tools::GFF. See L<Bio::Tools::GFF>.
239 =head2 scripts/tools/gff2ps.pl
241 Takes an input file in GFF format and draws its genes and features as
242 Postscript using Tools::GFF. See L<Bio::Tools::GFF>.
244 =head2 scripts/tools/parse_codeml.pl
246 Script that parses output from codeml, one of the PAML programs. See
247 L<Bio::Tools::Phylo::PAML>.
249 =head2 scripts/tools/psw.pl
251 Example code for using the XS extensions for comparing proteins 
252 using Smith-Waterman.
254 =head2 scripts/tools/remote_blast.pl
256 This script executes remote Blast using RemoteBlast. See 
257 L<Bio::Tools::Run::RemoteBlast> for more information.
259 =head2 scripts/tools/restriction.pl
261 Example code for using the RestrictionEnzyme module. See
262 L<Bio::Tools::RestrictionEnzyme> for more information.
264 =head2 scripts/tools/run_genscan.pl
266 Run GENSCAN on multiple sequences and create output sequence files
267 using Tools::Genscan. Please see L<Bio::Tools::Genscan> for more information.
269 =head2 scripts/tools/seq_pattern.pl
271 A script that shows how to use sequences as regular expressions using
272 Tools::SeqPattern. Please see L<Bio::Tools::SeqPattern> for more information.
274 =head2 scripts/tools/state-machine.pl
276 A demonstration of how to create a state machine using
277 StateMachine::AbstractStateMachine. Please see
278 L<Bio::Tools::StateMachine::AbstractStateMachine> for more information.
280 =head2 scripts/tools/test-genscan.pl
282 Script for testing and demonstrating Bio::Tools::Genscan.
284 =head2 scripts/tree/paup2phylip.pl
286 Convert a PAUP tree block to Phylip format.
288 =cut