Skip to content

Commit

Permalink
Simplify download using /packages
Browse files Browse the repository at this point in the history
  • Loading branch information
ms609 committed Jan 5, 2024
1 parent d0f85d4 commit 2d1ba57
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 14 deletions.
21 changes: 14 additions & 7 deletions R/tree_distance_info.R
Original file line number Diff line number Diff line change
Expand Up @@ -94,18 +94,25 @@
#' To balance memory demands and runtime with flexibility, these functions are
#' implemented for trees with up to 2048 leaves.
#' To analyse trees with up to 8192 leaves, you will need to a modified version
#' of \pkg{TreeTools}.
#' First uninstall \pkg{TreeDist} and \pkg{TreeTools} using `remove.packages()`.
#' Then use `devtools::install_github("ms609/TreeTools", ref = "more-leaves")`
#' to install the modified \pkg{TreeTools} package.
#' Finally, install \pkg{TreeDist} using
#'`devtools::install_github("ms609/TreeDist")`.
#' of the package:
#' `install.packages("BigTreeDist", repos = "https://ms609.github.io/packages/")`
#' Use `library("BigTreeDist")` *instead* of `library("TreeDist")` to load
#' the modified package – or prefix functions with the package name, e.g.
#' `BigTreeDist::TreeDistance()`.
#'
#' As an alternative download method,
#' uninstall \pkg{TreeDist} and \pkg{TreeTools} using
#' `remove.packages()`, then use
#' `devtools::install_github("ms609/TreeTools", ref = "more-leaves")`
#' to install the modified \pkg{TreeTools} package; then,
#' install \pkg{TreeDist} using
#' `devtools::install_github("ms609/TreeDist", ref = "more-leaves")`.
#' (\pkg{TreeDist} will need building from source _after_ the modified
#' \pkg{TreeTools} package has been installed, as its code links to values
#' set in the TreeTools source code.)
#'
#' Trees with over 8192 leaves require further modification of the source code,
#' which the maintainer will attempt on demand; please [comment on GitHub](
#' which the maintainer plans to attempt in the future; please [comment on GitHub](
#' https://github.com/ms609/TreeTools/issues/141) if you would find this useful.
#'
#' @template tree12ListParams
Expand Down
21 changes: 14 additions & 7 deletions man/TreeDistance.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2d1ba57

Please sign in to comment.