File: post_payload.Rd

package info (click to toggle)
r-bioc-stringdb 2.18.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 10,572 kB
  • sloc: makefile: 5
file content (43 lines) | stat: -rw-r--r-- 1,347 bytes parent folder | download | duplicates (2)
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
\name{post_payload}
\alias{\S4method{post_payload}{STRINGdb}}
\title{
post_payload
}
\description{
Posts the input to STRING and returns an identifier that you can use to access the payload when you enter in our website.
}
\usage{
\S4method{post_payload}{STRINGdb}(stringIds, colors=NULL, comments=NULL, links=NULL, iframe_urls=NULL, logo_imgF=NULL, legend_imgF=NULL )
}
\arguments{
  \item{stringIds}{
vector of STRING identifiers.
}
  \item{colors}{
vector containing the colors to use for a every STRING identifier ( the order of the elements must match those in the string_ids vector)
}
  \item{comments}{
vector containing the comments to use for every STRING identifier ( the order of the elements must match those in the string_ids vector)
}
  \item{links}{
vector containing the links to use for every STRING identifier ( the order of the elements must match those in the string_ids vector)
}
  \item{iframe_urls}{
vector containing the urls of the iframes to use for every STRING identifier 
( the order of the elements must match those in the string_ids vector).
}
  \item{logo_imgF}{
path to a file containing the logo image to be display in the STRING website
}
  \item{legend_imgF}{
path to a file containing a legend image to be display in the STRING website
}
}
\value{
identifier of the payload.
}
\author{
Andrea Franceschini
}