-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathrba_mieaa_convert_type.Rd
80 lines (73 loc) · 2.64 KB
/
rba_mieaa_convert_type.Rd
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/mieaa.R
\name{rba_mieaa_convert_type}
\alias{rba_mieaa_convert_type}
\title{Convert Between Mature and precursor miRNA Accession}
\usage{
rba_mieaa_convert_type(
mirna,
input_type,
only_unique = FALSE,
simple_output = FALSE,
...
)
}
\arguments{
\item{mirna}{A vector of miRNA accessions to be converted.}
\item{input_type}{Type of your supplied miRNA accession. either "mature"
or "precursor".}
\item{only_unique}{(logical) miRBase precursor and mature miRNA accessions
are not uniquely mapped. (i.e. you may get more than one results for
a given accession). set this to TRUE to only retrieve the unique mappings.
(default = FALSE)}
\item{simple_output}{(logical) If FALSE (default), the result will be a
two-columned data frame with your input and output accessions. Otherwise,
if TRUE, only the output miRNA accessions will be returned.}
\item{...}{rbioapi option(s). See \code{\link{rba_options}}'s
arguments manual for more information on available options.}
}
\value{
Depending on the arguments, a data frame or a character vectors
containing the miRNA accessions in your output version.
}
\description{
miRBase miRNA accession could refer to either mature or precursor miRNAs.
(see: \href{https://rnajournal.cshlp.org/content/9/3/277}{A uniform system
for microRNA annotation}). Use this function to mature miRNA accession to
corresponding miRNA accessions or vice versa.
}
\section{Corresponding API Resources}{
"POST https://ccb-compute2.cs.uni-saarland.de/mieaa2/api/v1/mirna_precursor_converter/"
}
\examples{
\donttest{
Sys.sleep(1) # to prevent 429 error during R CMD check
rba_mieaa_convert_type(mirna = c("hsa-miR-20b-5p", "hsa-miR-144-5p"),
input_type = "mature")
}
}
\references{
\itemize{
\item Fabian Kern, Tobias Fehlmann, Jeffrey Solomon, Louisa Schwed,
Nadja Grammes, Christina Backes, Kendall Van Keuren-Jensen,
David Wesley Craig,Eckart Meese, Andreas Keller, miEAA 2.0:
integrating multi-species microRNA enrichment analysis and workflow
management systems, Nucleic Acids Research, Volume 48, Issue W1,
02 July 2020, Pages W521–W528, https://doi.org/10.1093/nar/gkaa309
\item
\href{https://ccb-compute2.cs.uni-saarland.de/mieaa2/tutorial/api/}{miEAA
browsable API tutorial}
\item \href{https://ccb-compute2.cs.uni-saarland.de/mieaa2/}{Citations note
on miEAA website}
}
}
\seealso{
Other "miEAA":
\code{\link{rba_mieaa_cats}()},
\code{\link{rba_mieaa_convert_version}()},
\code{\link{rba_mieaa_enrich}()},
\code{\link{rba_mieaa_enrich_results}()},
\code{\link{rba_mieaa_enrich_status}()},
\code{\link{rba_mieaa_enrich_submit}()}
}
\concept{"miEAA"}