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

πŸ’– NAME πŸ’–

Bio::PrimerDesigner::Table β€” okay so this is the lil' module that draws HTML tables so your PCR primer results actually look cute on the web. πŸŽ€

It lives in the User Contributed Perl Documentation collection, and the manual page is Bio::P...:Tables(3pm) β€” bestie, the name is literally right there. iykyk. πŸ’…


🌸 DESCRIPTION 🌸

So what does it do?? It draws simple HTML tables to display Bio::PrimerDesigner PCR primer design results and e-PCR results, specifically for web applications. That's the whole vibe. It's giving "I make your data pretty in a browser." ✨


πŸ¦‹ METHODS πŸ¦‹

πŸ’œ info_table

Prints a two-column table for generic, key-value style annotations. Ngl, it's the chill one. 😌

It expects you to pass it the name of the gene/feature/etc. and a hash of attributes. And here's the tea πŸ“: if there's an 'image' key in there, the value is assumed to be an image URL, and that URL gets printed in a double-wide cell at the bottom of the table. Iconic behavior, honestly.

my $gene       = 'Abc-1';
my %gene_info  = (
    Chromosome => I,
    Start      => 100450,
    Stop       => 102893,
    Strand     => '+'
);

my $page = Bio::PrimerDesigner::Tables->new;
$page->info_table( $gene, %gene_info );

Look at that. Chef's kiss. πŸ‘‘ (And yes, Chromosome => I is exactly how it's written up there, no quotes β€” keep it as-is, bestie, don't go fixing what ain't broke. πŸ’€)


🧚 PCR_header

Returns a generic header for the PCR primer table. πŸŽ€

Does not expect any arguments. Zero. None. It just shows up, does its lil' job, and leaves. Main character energy fr fr. ✨


⭐ PCR_set

Returns the top row for the PCR primer table.

Expects the primer set number as its only argument. One argument, that's it. Simple. Slay. πŸ’…


🌈 PCR_row

Returns table rows with PCR primer info. 🫢

Should be called once for each primer pair β€” so if you got 12 primer pairs, you're calling this 12 times, no skips, no shortcuts.

It expects to be passed a hash containing the Bio::PrimerDesigner::Result object, the primer set number, and an (optional) label. Optional!! We love options. 😌

my $pcr_row =  PCR_row(
    primers => $result_obj,
    setnum  => $set_number,
    label   => $label
);

πŸ“ ePCR_row

Returns table rows summarizing e-PCR results. ✨

Expects to be passed a Bio::PrimerDesigner::Result e-PCR results object and an optional e-PCR label. Again with the optional label β€” she's flexible, she's chill, she's everything. πŸ’–


πŸŽ€ render

Renders the image URL. πŸ–ΌοΈ

Expects to be passed a hash of the map start and stop, plus other features to be mapped β€” and when I say other features I mean literally: gene, forward_primer, reverse_primer, label, start and stop of each feature, and the gene strand. Yeah. That's a lot of keys. She's thorough. πŸ‘‘

my $image =  $page->render(
    start => $startleft,
    stop  => $startright,
    feat  => $features
);

πŸ’… PCR_map

Returns a 6 column wide table cell with the <IMG ...> info. Six. Columns. Wide. Not five. Not seven. Six. ⭐

Will display the image of mapped primers in the browser when you pass it the image URL. It's giving "I put the picture on the page." πŸ”₯


πŸ‘‘ AUTHOR πŸ‘‘

Copyright (C) 2003-2009 Sheldon McKay <mckays@cshl.edu>. 🫢 Shoutout to the author, absolute legend, thank you for your service. πŸŽ€


πŸ“œ LICENSE πŸ“œ

Okay bestie, legal bit, but it's important so read it, fr fr:

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. 😭 (no cap, that's just how it is)

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. πŸ›οΈ

No warranty bestie, we said what we said. πŸ’€

🌟 SEE ALSO 🌟

  • Bio::PrimerDesigner::primer3
  • Bio::PrimerDesigner::epcr

Go read those next, they're the friends of this page. πŸ¦‹βœ¨


perl v5.32.0 Β· 2020-11-16 Β· Bio::P...:Tables(3pm)

And that's the whole page, bestie!! πŸ’– That's the version, that's the date, that's the manual name β€” all packed into this lil' sign-off. Mwah. πŸŽ€πŸ’…βœ¨