File: knowndbs.Rd

package info (click to toggle)
r-cran-seqinr 3.4-5-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 5,876 kB
  • sloc: ansic: 1,987; makefile: 14
file content (52 lines) | stat: -rw-r--r-- 1,667 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
\name{knowndbs}
\alias{knowndbs}
\alias{kdb}
\title{Description of databases known by an ACNUC server}
\description{
Returns, for each database known by the server, its name (a valid value for the \code{bank} 
argument of \code{\link{choosebank}}), availability (off means temporarily unavailable), 
and description.
}
\usage{
knowndbs(tag = c(NA, "TP", "TEST", "DEV"), socket = autosocket())
kdb(tag = c(NA, "TP", "TEST", "DEV"), socket = autosocket())
}
\arguments{
  \item{tag}{default to NA, see details}
  \item{socket}{an object of class \code{sockconn} connecting to a remote ACNUC
                        database (default is a socket to the last opened database).}
}

\details{
When the optional \code{tag}  argument is used, only databases tagged with the given 
string are listed;
when this argument is NA (by default), only untagged databases are listed.
The \code{tag} argument thus allows to identify series of special purpose (tagged) databases, 
in addition to default (untagged) ones.
}

\value{
A dataframe with 3 columns:
\item{bank}{string. Valid bank values known by the ACNUC server}
\item{status}{string. "on" means available, "off" means temporarily unavailable}
\item{info}{string. short description of the database}
}
\references{ \url{http://doua.prabi.fr/databases/acnuc.html}

\code{citation("seqinr")}

The full list of untagged and tagged databases is here : 
\url{http://doua.prabi.fr/databases/acnuc/banques_raa.php}.

}
\author{J.R. Lobry}
\seealso{\code{\link{choosebank}} when called without arguments. }
\examples{
\dontrun{ 
  ### Need internet connection
  choosebank("emblTP")
  kdb()
  closebank()
  }
}
\keyword{ utilities }