Browse code

markdownified roxygen blocks

Federico Marini authored on 12/09/2024 13:07:22
Showing 1 changed files
... ...
@@ -7,7 +7,7 @@
7 7
 \item{...}{Ignored arguments.}
8 8
 }
9 9
 \value{
10
-All functions throw a warning, with a deprecation message pointing 
10
+All functions throw a warning, with a deprecation message pointing
11 11
 towards its descendent (if available).
12 12
 }
13 13
 \description{
... ...
@@ -16,14 +16,15 @@ Their successors are also listed.
16 16
 }
17 17
 \details{
18 18
 The successors of these functions are likely coming after the rework that
19
-led to the creation of the `mosdef` package. See more into its 
19
+led to the creation of the \code{mosdef} package. See more into its
20 20
 documentation for more details.
21 21
 }
22 22
 \section{Transitioning to the mosdef framework}{
23 23
 
24
-
25
-* [topGOtable()] is now being replaced by the more flexible 
26
-[mosdef::run_topGO()] function
24
+\itemize{
25
+\item \code{\link[=topGOtable]{topGOtable()}} is now being replaced by the more flexible
26
+\code{\link[mosdef:run_topGO]{mosdef::run_topGO()}} function
27
+}
27 28
 }
28 29
 
29 30
 \examples{
Browse code

manpage rendered for the deprecated function(s)

Federico Marini authored on 11/09/2024 23:10:50
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,35 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/deprecated.R
3
+\name{deprecated}
4
+\alias{deprecated}
5
+\title{Deprecated functions in pcaExplorer}
6
+\arguments{
7
+\item{...}{Ignored arguments.}
8
+}
9
+\value{
10
+All functions throw a warning, with a deprecation message pointing 
11
+towards its descendent (if available).
12
+}
13
+\description{
14
+Functions that are on their way to the function afterlife.
15
+Their successors are also listed.
16
+}
17
+\details{
18
+The successors of these functions are likely coming after the rework that
19
+led to the creation of the `mosdef` package. See more into its 
20
+documentation for more details.
21
+}
22
+\section{Transitioning to the mosdef framework}{
23
+
24
+
25
+* [topGOtable()] is now being replaced by the more flexible 
26
+[mosdef::run_topGO()] function
27
+}
28
+
29
+\examples{
30
+# try(topGOtable())
31
+
32
+}
33
+\author{
34
+Federico Marini
35
+}