Package 'ghettoblaster'

Title: NCBI BLAST web client
Description: NCBI BLAST web client.
Authors: Pieter Provoost [cre, aut]
Maintainer: Pieter Provoost <[email protected]>
License: `use_mit_license()`
Version: 0.0.1
Built: 2024-11-22 03:05:29 UTC
Source: https://github.com/pieterprovoost/ghettoblaster

Help Index


Run a BLAST search

Description

Run a BLAST search

Usage

blast(sequence, max_num_seq = 100, verbose = FALSE, add_worms = FALSE)

Arguments

sequence

A DNA sequence

max_num_seq

The maximum number of sequences to return

verbose

Whether to print status messages

add_worms

Whether to add WoRMS taxonomy information

Value

A data frame with the BLAST results


Get the results of a BLAST request

Description

Get the results of a BLAST request

Usage

get_results(rid)

Arguments

rid

A request ID

Value

A data frame with the results


Get WoRMS taxonomy for a list of species names

Description

Get WoRMS taxonomy for a list of species names

Usage

get_taxonomy(species_names)

Arguments

species_names

A character vector of species names

Value

A data frame with the taxonomy, input names in column input


NCBI BLAST web client

Description

This package provides a simple interface to the NCBI BLAST web service.


Submit a sequence to NCBI BLAST

Description

Submit a sequence to NCBI BLAST

Usage

submit_sequence(sequence, program = "blastn", max_num_seq = 100)

Arguments

sequence

A DNA sequence

program

The BLAST program to use

max_num_seq

The maximum number of sequences to return

Value

A request ID


Wait until a BLAST request is ready

Description

Wait until a BLAST request is ready

Usage

wait_until_ready(rid, verbose = FALSE)

Arguments

rid

A request ID

verbose

Whether to print status messages

Value

TRUE if the request is ready, FALSE in case of an unexpected status


Get WoRMS taxonomy for a list of species names

Description

Get WoRMS taxonomy for a list of species names

Usage

worms_for_names(...)

Arguments

species_names

A character vector of species names

Value

A data frame with the taxonomy, input names in column input