Bio::P...:Result(3pm)

πŸ’– Bio::P...:Result β€” the manual page, bestie edition πŸ’–

User Contributed Perl Documentation Β· Bio::P...:Result(3pm)

okay so you found the Bio::PrimerDesigner::Result page?? slay. this is the class that handles your primer design and validation results, and honestly? it's giving "quiet overachiever." let's get into it 🫢


✨ NAME ✨

Bio::PrimerDesigner::Result β€” a whole class dedicated to handling primer design or validation results. she holds the receipts. πŸ’…


🌸 SYNOPSIS 🌸

use Bio::PrimerDesigner;

#
# primer3
#
my $primer3_obj = Bio::PrimerDesigner->new( program => 'primer3 );
my $result = $primer3_obj->design( %hash_of_options );
my $left_primer = $result->left;
my @left_primers = $result->left(1..$num_primers);

#
# e-PCR -- first make a hash of options from primer3 results
# then run e-PCR
#
my $epcr_obj = Bio::PrimerDesigner->new( program => 'primer3 );
my $epcr_result = $epcr_obj->design( %hash_of_options );
my $num_products = $epcr_result->products;

#
# one product
#
my $first_prod_size = $epcr_result->size;
my $first_prod_start = $epcr_result->start;
my $first_prod_stop = $epcr_result->start;

#
# more than one product
#
my @pcr_product_sizes = ();
for (1..$num_products) {
    push @pcr_product_sizes, $epcr_result->size;
}

like look at her go πŸƒβ™€οΈπŸ’¨


πŸ¦‹ DESCRIPTION πŸ¦‹

so Bio::PrimerDesigner::Result will autogenerate result access methods for for Native Boulder IO keys and Bio::PrimerDesigner keys β€” for primer3, e-PCR, isPcr and ipcress. no cap, she just makes the accessors for you so you don't have to. main character energy fr fr ✨


πŸ‘‘ METHODS πŸ‘‘

πŸŽ€ keys πŸŽ€

this one handles all the result method calls made through the Bio::PrimerDesigner::Result object. what you get back depends on what you pass in β€” scalar or list, bestie, it's a whole vibe check:

  • nothing passed β†’ returns the scalar value for set 1
  • a numeric n β†’ returns the scalar value for set n
  • a numeric list 1..n β†’ returns a list with n elements
for reference, the original lays it out like this: text ------------------+------------------------ Args passed | Returns ------------------+------------------------ none scalar value for set 1 numeric n scalar value for set n numeric list 1..n list with n elements

the aliased output methods (they're right below, keep scrolling πŸ’…) return a string when you call them in scalar context, and a list when you call them in list context. the native primer3 (Boulder IO) keys work too. and yeah, there are also e-PCR, isPcr and ipcress specific methods. versatile queen πŸ‘‘

🌈 Primer3 keys

  • left β€” left primer sequence
  • right β€” right primer sequence
  • hyb_oligo β€” internal oligo sequence
  • startleft β€” left primer 5' sequence coordinate
  • startright β€” right primer 5' sequence coordinate
  • tmleft β€” left primer tm
  • tmright β€” right primer tm
  • qual β€” primer pair penalty (Q value)
  • lqual β€” left primer penalty
  • rqual β€” right primer penalty
  • leftgc β€” left primer % gc
  • rightgc β€” right primer % gc
  • lselfany β€” left primer self-complementarity (any)
  • lselfend β€” left primer self-complementarity (end)
  • rselfany β€” right primer self-complementarity (any)
  • rselfend β€” right primer self-complementarity (end)
  • pairanycomp β€” primer pair complementarity (any)
  • pairendcomp β€” primer pair complementarity (end)
  • lendstab β€” left primer end stability
  • rendstab β€” right primer end stability
  • amplicon β€” amplified PCR product

πŸ“ Other keys

  • products β€” number of PCR products
  • size β€” product size
  • start β€” product start coordinate
  • stop β€” product stop coordinate
  • end β€” synonymous with stop
  • strand β€” strand of product relative to the ref. sequence (isPCR, ipcress)
  • amplicon β€” returns the PCR product (isPCR only)

πŸ’œ AUTHOR πŸ’œ

Copyright (c) 2003-2009 Sheldon McKay <mckays@cshl.edu>, Ken Youens-Clark <kclark@cpan.org>. legends, honestly πŸ™Œ


⭐ LICENSE ⭐

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 3 or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. (like, she's free but she's not making any promises, ok?? πŸ™ˆ)

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


πŸ”₯ SEE ALSO πŸ”₯

  • Bio::PrimerDesigner

okay that's the whole page, bestie!! πŸŽ€ this one's from the perl v5.32.0 era, dated 2020-11-16, and it lives at Bio::P...:Result(3pm). go forth and design those primers, you've got this πŸ’–βœ¨πŸ¦‹