seqinr: ghelp – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

ghelp

Get help from an ACNUC server

Description

Reads one item of information in specified help file from an ACNUC server. The are differences between ACNUC clients so that this help could be confusing. However, the query language is common to all clients so that the most recent documentation is most likely here.

Usage

ghelp(item = c("GENERAL", "SELECT", "SPECIES", "KEYWORD"),
 file = c("HELP", "HELP_WIN"), socket = autosocket(), catresult = TRUE)

Arguments

`item`	the name of the desired help item
`file`	the name of the help file on server side.
`socket`	an object of class `sockconn` connecting to a remote ACNUC database (default is a socket to the last opened database).
`catresult`	logical. If TRUE output is redirected to the console.

Value

A vector of string which is returned invisibly and "cated" to the console by default.

Author(s)

J.R. Lobry

References

http://doua.prabi.fr/databases/acnuc.html

citation("seqinr")

Examples

## Not run:  
  ### Need internet connection
  choosebank("emblTP")
  ghelp()
  ghelp("SELECT")
  # To get info about current database:
  ghelp("CONT")
  
## End(Not run)

seqinr

Biological Sequences Retrieval and Analysis

v4.2-16

GPL (>= 2)

Authors

Delphine Charif [aut], Olivier Clerc [ctb], Carolin Frank [ctb], Jean R. Lobry [aut, cph], Anamaria Necşulea [ctb], Leonor Palmeira [ctb], Simon Penel [cre], Guy Perrière [ctb]

Initial release

2022-05-19