Skip to content

Commit 841dc9c

Browse files
committed
update roxygen to markdown syntax
1 parent c941e3d commit 841dc9c

8 files changed

+24
-16
lines changed

DESCRIPTION

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: tidytree
22
Title: A Tidy Tool for Phylogenetic Tree Data Manipulation
3-
Version: 0.2.4
3+
Version: 0.2.5
44
Authors@R: c(
55
person("Guangchuang", "Yu", email = "[email protected]", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0002-6485-8781")),
66
person("Bradley", "Jones", email = "[email protected]", role = "ctb"),
@@ -32,3 +32,4 @@ BugReports: https://github.com/GuangchuangYu/tidytree/issues
3232
Encoding: UTF-8
3333
LazyData: true
3434
RoxygenNote: 6.1.1
35+
Roxygen: list(markdown = TRUE)

Makefile

+10-7
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,23 @@ readme:
1212

1313

1414
build:
15-
cd ..;\
16-
R CMD build $(PKGSRC)
15+
Rscript -e 'devtools::build()'
16+
# cd ..;\
17+
# R CMD build $(PKGSRC)
1718

1819
build2:
19-
cd ..;\
20-
R CMD build --no-build-vignettes $(PKGSRC)
20+
Rscript -e 'devtools::build(vignettes = FALSE)'
21+
# cd ..;\
22+
# R CMD build --no-build-vignettes $(PKGSRC)
2123

2224
install:
2325
cd ..;\
2426
R CMD INSTALL $(PKGNAME)_$(PKGVERS).tar.gz
2527

26-
check: build
27-
cd ..;\
28-
Rscript -e 'rcmdcheck::rcmdcheck("$(PKGNAME)_$(PKGVERS).tar.gz", args="--as-cran")'
28+
check:
29+
Rscript -e 'devtools::check()'
30+
# cd ..;\
31+
# Rscript -e 'rcmdcheck::rcmdcheck("$(PKGNAME)_$(PKGVERS).tar.gz", args="--as-cran")'
2932

3033
check2: build
3134
cd ..;\

NEWS.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# tidytree 0.2.5
2+
3+
+ convert elements of roxygen documentation to markdown (2019-05-05, Thu)
4+
15
# tidytree 0.2.4
26

37
+ call `child.tbl_tree` instead of `child` in `offspring`, (2019-02-26, Tue)

R/AllClasses.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ setOldClass("DNAbin")
2626
##' @importFrom methods representation
2727
##' @importFrom ape as.DNAbin
2828
##' @exportClass treedata
29-
##' @author guangchuang yu \url{https://guangchuangyu.github.io}
29+
##' @author Guangchuang Yu <https://guangchuangyu.github.io>
3030
##' @keywords classes
3131
setClass("treedata",
3232
representation = representation(

R/AllGenerics.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ as.treedata <- function(tree, ...) {
2121
##' @name get.fields
2222
##' @rdname get.fields-methods
2323
##' @title get.fields method
24-
##' @param object \code{treedata} object
24+
##' @param object `treedata` object
2525
##' @param ... additional parameter
2626
##' @return available annotation variables
2727
##' @export
@@ -31,7 +31,7 @@ setGeneric("get.fields", function(object, ...) standardGeneric("get.fields"))
3131
##' @name get.data
3232
##' @rdname get.data-methods
3333
##' @title get.data method
34-
##' @param object \code{treedata} object
34+
##' @param object `treedata` object
3535
##' @param ... additional parameter
3636
##' @return associated data of phylogeny
3737
##' @export

R/as-tibble.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ as_tibble.treedata <- function(x, ...) {
7474
##'
7575
##'
7676
##' @title get_tree_data
77-
##' @param tree_object a \code{treedata} object
77+
##' @param tree_object a `treedata` object
7878
##' @return tbl_df
7979
##' @export
8080
##' @author guangchuang yu

R/show.R

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
##' show method for \code{treedata} instance
1+
##' show method for `treedata` instance
22
##'
33
##'
44
##' @name show
55
##' @docType methods
66
##' @rdname show-methods
77
##'
88
##' @title show method
9-
##' @param object \code{treedata} object
9+
##' @param object `treedata` object
1010
##' @return print info
1111
##' @importFrom methods show
1212
##' @exportMethod show
1313
##' @usage show(object)
14-
##' @author Guangchuang Yu \url{https://guangchuangyu.github.io}
14+
##' @author Guangchuang Yu <https://guangchuangyu.github.io>
1515
setMethod("show", signature(object = "treedata"),
1616
function(object) {
1717
print.treedata(object)

man/treedata-class.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)