diff --git a/NEWS.md b/NEWS.md index 7b2af64..53697ec 100644 --- a/NEWS.md +++ b/NEWS.md @@ -4,6 +4,38 @@ * Wrapped `outsider` package as it has been archived. * Updated and fixed the dependency to `restez`. +There are a lot of CRAN submission problems pointed by Victoria Wimmer and I have no patience to handle them, I am not able to release it to CRAN. + +``` +Please add \value to .Rd files regarding exported methods and explain +the functions results in the documentation. Please write about the +structure of the output (class) and also what the output means. (If a +function does not return a value, please document that too, e.g. +\value{No return value, called for side effects} or similar) +Missing Rd-tags in up to 93 .Rd files, e.g.: + addClade.Rd: \value + addNdmtrx.Rd: \value + addTip.Rd: \value + blncdTree.Rd: \value + calcDstBLD.Rd: \value + calcDstMtrx.Rd: \value + ... + +You write information messages to the console that cannot be easily +suppressed. It is more R like to generate objects that can be used to +extract the information a user is interested in, and then print() that +object. +Instead of print()/cat() rather use message()/warning() or +if(verbose)cat(..) (or maybe stop()) if you really have to write text to +the console. +(except for print, summary, interactive functions) + +Please do not modify the global environment (e.g. by using <<-) in your +functions. This is not allowed by the CRAN policies. + +Please fix and resubmit. +``` + # phylotaR 1.2.0 ## `outsider` integration diff --git a/README.md b/README.md index 60318e3..1701e5d 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,8 @@ R implementation of the PhyLoTa sequence cluster pipeline. For more information ## Install -From CRAN: - -```r -install.packages('phylotaR') -``` - -Or, download the development package from GitHub: - ```r +install.packages("remotes") remotes::install_github('ropensci/phylotaR') ```