Skip to content

Commit

Permalink
Ran usethis::use_package_doc()
Browse files Browse the repository at this point in the history
  • Loading branch information
knausb committed Dec 1, 2023
1 parent cb35302 commit 117c281
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 8 deletions.
6 changes: 5 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ I think I encountered a situation where 4-96 was not enough so I've bumped it to
This may have been addressed at 64a308ba50b9119108e8946737460de5997b805b by adding `samples` to vcfR method `[`.
* In issue #92 (vcfR2genlight big data #92), JimWhiting91 has documented that `extract.gt()` could be greatly improved with multithreading. While he used `mclapply()` I do not feel this is the best solution because it does not work on Windows. I think a better solution would be [RCppParallel](https://rcppcore.github.io/RcppParallel/) because this should work on all CRAN platforms.

# vcfR 1.15.0
Released on CRAN 2023-XX-XX
* Ran usethis::use_package_doc()

# vcfR 1.14.0
Released on CRAN 202X-XX-XX
Released on CRAN 2023-02-10
* Compile time 'nodiscard' attribute: changed 'col_vec.size()' to 'sizeof(col_vec)' in ad_frequency.cpp and masplit.cpp
* vcfR_to_tidy handles no INFO in meta

Expand Down
6 changes: 6 additions & 0 deletions R/vcfR-package.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL
4 changes: 2 additions & 2 deletions R/vcfR.R
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
#' @import pinfsc50
#' @import ape
#' @docType package
#' @name vcfR
#' @rdname vcfR
#' @name vcfR-package
# ' @rdname vcfR
#' @useDynLib vcfR, .registration = TRUE
#' @importFrom Rcpp sourceCpp
#' @importFrom stats setNames
Expand Down
3 changes: 2 additions & 1 deletion R/vcfR_to_tidy_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
#' with very large data sets, they provide a good framework for handling and filtering
#' large variant data sets. For some background
#' on the benefits of such "tidy" data frames, see
#' \doi{doi.org/10.18637/jss.v059.i10}{this article}.
#' \doi{doi.org/10.18637/jss.v059.i10}.
# ' \doi{doi.org/10.18637/jss.v059.i10}{this article}.
# ' \href{https://doi.org/10.18637/jss.v059.i10}{this article}.
# ' \href{https://www.jstatsoft.org/article/view/v059i10}{this article}.
#'
Expand Down
34 changes: 31 additions & 3 deletions man/vcfR.Rd → man/vcfR-package.Rd

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

2 changes: 1 addition & 1 deletion man/vcfR_to_tidy_conversion.Rd

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

0 comments on commit 117c281

Please sign in to comment.