diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index cea7ca2..07ea572 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -49,7 +49,7 @@ jobs: shell: Rscript {0} - name: Restore R package cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ${{ env.R_LIBS_USER }} key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }} diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index ba1f94f..8ea77e3 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -30,7 +30,7 @@ jobs: shell: Rscript {0} - name: Restore R package cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ${{ env.R_LIBS_USER }} key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }} diff --git a/DESCRIPTION b/DESCRIPTION index 7354954..f1669bc 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,8 +11,8 @@ Authors@R: c( person(given = "Cristian", family = "Roman-Palacios", role = c("aut","cre"), - email = "cromanpa94@email.arizona.edu", - comment = c(ORCID="0000-0003-4692-3225") + email = "cromanpa@arizona.edu", + comment = c(ORCID="0000-0003-1696-4886") ), person(given = "April", family = "Wright", @@ -29,13 +29,14 @@ Authors@R: c( family = "Norman", role = c("rev")) ) -URL: https://ropensci.github.io/treedata.table, https://docs.ropensci.org/treedata.table/, https://github.com/ropensci/treedata.table/ +URL: https://ropensci.github.io/treedata.table/, https://docs.ropensci.org/treedata.table/, https://github.com/ropensci/treedata.table/ BugReports: https://github.com/ropensci/treedata.table/issues Description: An implementation that combines trait data and a phylogenetic tree (or trees) into a - single object of class treedata.table. The resulting object can be easily + single object of class 'treedata.table'. The resulting object can be easily manipulated to simultaneously change the trait- and tree-level sampling. Currently implemented functions allow users to use a 'data.table' syntax when - performing operations on the trait dataset within the treedata.table object. + performing operations on the trait dataset within the 'treedata.table' object. + For more details see Roman-Palacios et al. (2021) . License: MIT + file LICENSE Depends: R (>= 2.10), diff --git a/R/tdt_methods.R b/R/tdt_methods.R index 45440f9..8a91888 100644 --- a/R/tdt_methods.R +++ b/R/tdt_methods.R @@ -2,6 +2,7 @@ #' #' @param x a treedata.table object #' @param ... Additional arguments passed to head.data.table +#' @return First part of an treedata.table object #' @examples #' data(anolis) #' td <- as.treedata.table(anolis$phy, anolis$dat) @@ -17,6 +18,7 @@ head.treedata.table <- function(x, ...) { #' #' @param x a treedata.table object #' @param ... Additional arguments passed to head.data.table +#' @return Last part of an treedata.table object #' @examples #' data(anolis) #' td <- as.treedata.table(anolis$phy, anolis$dat) diff --git a/man/head.treedata.table.Rd b/man/head.treedata.table.Rd index 2c6a770..f24271a 100644 --- a/man/head.treedata.table.Rd +++ b/man/head.treedata.table.Rd @@ -11,6 +11,9 @@ \item{...}{Additional arguments passed to head.data.table} } +\value{ +First part of an treedata.table object +} \description{ Return the first part of an treedata.table object } diff --git a/man/tail.treedata.table.Rd b/man/tail.treedata.table.Rd index c251b24..9157bfa 100644 --- a/man/tail.treedata.table.Rd +++ b/man/tail.treedata.table.Rd @@ -11,6 +11,9 @@ \item{...}{Additional arguments passed to head.data.table} } +\value{ +Last part of an treedata.table object +} \description{ Return the last part of an treedata.table object }