Bio::D...iofetch(3pm)

πŸ“¦
version 1.7.4 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ NAME ✨

okay bestie, so Bio::D...iofetch(3pm) β€” that's the page you're on, and the actual thing it documents is Bio::DB::GFF::Adaptor::biofetch πŸ’… β€” and what it does is cache BioFetch objects in a Bio::DB::GFF database. that's it, that's the whole vibe.


πŸ“– SYNOPSIS πŸ“–

Proof of principle.  Not for production use.

fr fr, that's the entire synopsis. no flags, no usage line, just a warning label 😭 iconic of them honestly.


πŸ’– DESCRIPTION πŸ’–

so here's the tea πŸ«–: this adaptor is a proof-of-principle. it's used to fetch BioFetch sequences into a Bio::DB::GFF database as needed β€” and ngl, it currently uses a hard-coded EMBL database. which means you can use the Generic Genome Browser as a Genbank/EMBL browser 🌈. slay.


πŸ‘‘ AUTHOR πŸ‘‘

Lincoln Stein <lstein@cshl.org> β€” the icon, the legend, the main character πŸŽ€

Copyright 2002 Cold Spring Harbor Laboratory.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. periodt πŸ’œ


new

  • Title: new
  • Usage: $db = Bio::DB::GFF->new(-adaptor=>'biofetch',@args)
  • Function: create a new adaptor
  • Returns: a Bio::DB::GFF object
  • Args:
    • -adaptor : required. Which adaptor to use; biofetch for mysql, biofetch_oracle for Oracle
    • -preferred_tags : optional. A hash of {classname => weight,...} used to determine the class and name of the feature when a choice of possible feature classes is available (e.g. a feature has both a 'gene' and a 'locus' tag). Common defaults are provided that work well for eukaryotic features (but not well for viral/prokaryotic)
    • see below for additional arguments.
  • Status: Public

This is the constructor for the adaptor, bestie β€” it gets called automatically by Bio::DB::GFF->new, you don't have to do it yourself πŸ’…. On top of the arguments that are common among all adaptors, these class-specific arguments are recognized:

  • -dsn β€” the DBI data source, e.g. 'dbi:mysql:ens0040'
  • -user β€” username for authentication
  • -pass β€” the password for authentication
  • -proxy β€” [['http','ftp'],'http://proxy:8080']
  • -source β€” source to use for loaded features ('EMBL')

okay so let's break that down 🧚:

-dsn, -user and -pass indicate the local database to cache results in, and they work as per Bio::DB::GFF::Adaptor::dbi. easy.

The -proxy argument lets you set the biofetch web proxy, and it uses the same syntax described for the proxy() method of Bio::DB::WebDBSeqI β€” except that here the argument must be passed as an array reference. don't forget the arrayref, i'm begging you 😭


and that's the whole page!! this was perl v5.30.0, dated 2020-01-13, and it came to you via the User Contributed Perl Documentation crew πŸŽ€ no cap, go forth and cache responsibly πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from