bold-package.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bold-package.R
\docType{package}
\name{bold-package}
\alias{bold-package}
\alias{bold}
\title{bold}
\description{
bold: A programmatic interface to the Barcode of Life data
}
\section{About}{


This package gives you access to data from BOLD System
https://www.boldsystems.org/ via their API
(https://v4.boldsystems.org/index.php/api_home)
}

\section{Functions}{

\itemize{
\item \code{\link{bold_specimens}} - Search for specimen data
\item \code{\link{bold_seq}} - Search for and retrieve sequences
\item \code{\link{bold_seqspec}} - Get sequence and specimen data together
\item \code{\link{bold_trace}} - Get trace files - saves to disk
\item \code{\link{read_trace}} - Read trace files into R
\item \code{\link{bold_tax_name}} - Get taxonomic names via input names
\item \code{\link{bold_tax_id}} - Get taxonomic names via BOLD identifiers (Deprecated)
\item \code{\link{bold_tax_id2}} - Get taxonomic names via BOLD identifiers (improved)
\item \code{\link{bold_identify}} - Search for match given a COI sequence
\item \code{\link{bold_identify_parents}} - Adds guessed parent ranks (Deprecated)
\item \code{\link{bold_identify_taxonomy}} - Adds real parent ranks.
}

Interestingly, they provide xml and tsv format data for the specimen data,
while they provide fasta data format for the sequence data. So for the
specimen data you can get back raw XML, or a data frame parsed from the
tsv data, while for sequence data you get back a list (b/c sequences are
quite long and would make a data frame unwieldy).
}

\seealso{
Useful links:
\itemize{
  \item \url{https://docs.ropensci.org/bold/}
  \item \url{https://github.com/ropensci/bold}
  \item Report bugs at \url{https://github.com/ropensci/bold/issues}
}

}
\author{
\strong{Maintainer}: Salix Dubois \email{salixdubois+bold@gmail.com} (\href{https://orcid.org/0009-0003-0183-8825}{ORCID})

Authors:
\itemize{
  \item Scott Chamberlain \email{myrmecocystus@gmail.com} (\href{https://orcid.org/0000-0003-1444-9135}{ORCID})
}

}