getStrainLocal: Gets a single strain of a species

View source: R/bacdive_strain_access.R

getStrainLocalR Documentation

Gets a single strain of a species

Description

Gets a single strain of a species

Usage

getStrainLocal(
  list = NULL,
  rda = "data-raw/strain_large_list.rda",
  query,
  typestrain_only = F
)

Arguments

list

A list object containing strain information already present in the R environment. Required if an rda file is not given.

rda

An RData file representing a full download of strain from BacDive.org's API. Can be created using download_from_bacdive.Rmd. Required if list is not given.

query

Either a bacdive ID (integer) or species name (character).

typestrain_only

Whether to filter down to typestrains only.

Details

If you give typestrain_only = T and your BacDive-ID query is not a typestrain you will get zero results.

Value

A list containing information on the strain of a species.

Examples

## Not run: 
abyss <- getStrainLocal(query = "Abyssibacter profundi")

## End(Not run)

scottdaniel/bacphene documentation built on March 25, 2023, 12:51 p.m.