MakeTheBrainHappy / bioConda-Package-Repository-Search-Engine

A tutorial on how to produce your own bioConda package repository search engine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

bioConda Package Repository Search Engine

A tutorial on how to produce your own bioConda package repository search engine

DOI

Purpose

Currently there is not an efficient method to search bioConda repositories if you are not already familiar with the names of the programs you are looking for. For example, you would easily find the "STAR" alignment package individually; however, may have more difficulty finding all programs availiable in BioConda related to alignment.

Required Software

In order to run the Python Script you will need an up-to-date version of Python 3. The code was specifically written in Python 3.7.6. A recommended way to access Python is via the Spyder Console availiable from anaconda.com. Furthermore you will need HomeBrew in order to install both datasette and heroku.

Required Accounts

You can sign up for a free Heroku account for hosting at heroku.com. The account will come with 550 free dyno hours per month which can cover approx. 70-80% of the month for continous usage.

Instructions

Download the python script and open it from your working directory. This is the folder where you want the database file to be saved.

screenshot of where the page number is found on the package repository page

Find the current number of conda pages and place this value within the first parameter of the extractBioCondaData() function call within the main function (line 67). This will ensure that all the packages are pulled down from the conda repository.

Run the program and ensure that the database is generated.

Open Terminal. If necessary install homebrew, datasette and heroku CLI (command line interface).

Log into your Heroku account with the "heroku login" command.

Utilize the "datasette publish heroku mydatabase.db" command (replacing mydatabase.db with your database name) in order to publish the dataset to the cloud. Include the "-n my-app-name" flag on the end of the command in order to give your project a custom name. Once this has finished running you will be provided with a link where your database search applet is availiable.

Datasette Applet

See this page for example Datasette Applets: examples

The interface includes many different data outputs and custom SQL search features. The easiest way to search summaries is shown in the following screenshot (should be located two clicks into the table).

screenshot of how to search the datasette applet

About

A tutorial on how to produce your own bioConda package repository search engine


Languages

Language:Python 100.0%