File: help.r

package info (click to toggle)
r-cran-rentrez 1.2.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 388 kB
  • sloc: sh: 10; makefile: 6
file content (19 lines) | stat: -rwxr-xr-x 915 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#' rentrez
#'
#' rentrez provides functions to search for, discover and download data from
#' the NCBI's databases using their EUtils function. 
#'
#' Users are expected to know a little bit about the EUtils API, which is well
#' documented: \url{https://www.ncbi.nlm.nih.gov/books/NBK25500/}
#'
#' The NCBI will ban IPs that don't use EUtils within their \href{https://www.ncbi.nlm.nih.gov/corehtml/query/static/eutils_help.html}{user guidelines}. In particular
#' /enumerated{
#'  /item  Don't send more than three request per second (rentrez enforces this limit)
#'  /item  If you plan on sending a sequence of more than ~100 requests, do so outside of peak times for the US
#'  /item  For large requests use the web history method (see examples for \code{\link{entrez_search}} or use \code{\link{entrez_post}} to upload IDs)
#'}
#' @docType package
#' @name rentrez
#' @aliases rentrez rentrez-package
#' 
NULL