From 26987ea33fdda0a8bcab421215d011ef7bfbd667 Mon Sep 17 00:00:00 2001 From: Jouni Helske Date: Mon, 4 Sep 2023 14:02:04 +0300 Subject: [PATCH] updated docs --- ChangeLog | 5 ++++- DESCRIPTION | 53 ++++++++++++++++++++++---------------------- R/Rlibeemd-package.R | 2 +- R/zzz.R | 2 +- man/Rlibeemd.Rd | 1 + 5 files changed, 33 insertions(+), 30 deletions(-) diff --git a/ChangeLog b/ChangeLog index 75f2eae..d82f59d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ +Changes from version 1.4.2 to 1.4.3: + * Updated documentation due to roxygen2 changes. + Changes from version 1.4.1-1 to 1.4.2: - * Updateed configure script as requested by CRAN. + * Updated configure script as requested by CRAN. Changes from version 1.4.1 to 1.4.1-1: * Changed citation information. diff --git a/DESCRIPTION b/DESCRIPTION index a1d8944..3f08e32 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,27 +1,26 @@ -Package: Rlibeemd -Type: Package -Title: Ensemble Empirical Mode Decomposition (EEMD) and Its Complete - Variant (CEEMDAN) -Version: 1.4.2 -Date: 2021-10-06 -Authors@R: c(person(given = "Jouni", family = "Helske", role = c("aut","cre"), - comment = c("R interface", ORCID = "0000-0001-7130-793X"), email = "jouni.helske@iki.fi"), - person(given = "Perttu", family = "Luukko", role = "aut", comment = c("Original libeemd C - library", ORCID = "0000-0003-3786-9685"))) -Description: An R interface for libeemd (Luukko, Helske, Räsänen, 2016) , - a C library of highly efficient parallelizable functions for performing the ensemble empirical mode decomposition (EEMD), - its complete variant (CEEMDAN), the regular empirical mode decomposition (EMD), and bivariate EMD (BEMD). - Due to the possible portability issues CRAN version no longer supports OpenMP, you can install OpenMP-supported version - from GitHub: . -License: GPL-3 -NeedsCompilation: yes -SystemRequirements: GNU GSL -Imports: - stats, - Rcpp (>= 0.11.0) -Suggests: - testthat -LinkingTo: Rcpp -Encoding: UTF-8 -BugReports: https://github.com/helske/Rlibeemd/issues -RoxygenNote: 7.1.2 +Package: Rlibeemd +Type: Package +Title: Ensemble Empirical Mode Decomposition (EEMD) and Its Complete + Variant (CEEMDAN) +Version: 1.4.3 +Authors@R: c(person(given = "Jouni", family = "Helske", role = c("aut","cre"), + comment = c("R interface", ORCID = "0000-0001-7130-793X"), email = "jouni.helske@iki.fi"), + person(given = "Perttu", family = "Luukko", role = "aut", comment = c("Original libeemd C + library", ORCID = "0000-0003-3786-9685"))) +Description: An R interface for libeemd (Luukko, Helske, Räsänen, 2016) , + a C library of highly efficient parallelizable functions for performing the ensemble empirical mode decomposition (EEMD), + its complete variant (CEEMDAN), the regular empirical mode decomposition (EMD), and bivariate EMD (BEMD). + Due to the possible portability issues CRAN version no longer supports OpenMP, you can install OpenMP-supported version + from GitHub: . +License: GPL-3 +NeedsCompilation: yes +SystemRequirements: GNU GSL +Imports: + stats, + Rcpp (>= 0.11.0) +Suggests: + testthat +LinkingTo: Rcpp +Encoding: UTF-8 +BugReports: https://github.com/helske/Rlibeemd/issues +RoxygenNote: 7.2.3 diff --git a/R/Rlibeemd-package.R b/R/Rlibeemd-package.R index 75e65d3..f382354 100644 --- a/R/Rlibeemd-package.R +++ b/R/Rlibeemd-package.R @@ -20,7 +20,7 @@ #' } #' @docType package #' @name Rlibeemd -#' @aliases Rlibeemd +#' @aliases Rlibeemd Rlibeemd-package #' @useDynLib Rlibeemd #' @import Rcpp #' @importFrom stats time tsp "tsp<-" diff --git a/R/zzz.R b/R/zzz.R index 593ef22..d28f642 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -3,7 +3,7 @@ github_note <- paste0( "If you installed Rlibeemd from CRAN, consider installing again from ", "GitHub if you wish to support for parallel computations. ", - "See https://github.com/helske/Rlibeemd for details or use", + "See https://github.com/helske/Rlibeemd for details or use ", "devtools::install_github('helske/Rlibeemd')") citation_note <- paste0("\nPlease cite Rlibeemd in publications by using: \n", diff --git a/man/Rlibeemd.Rd b/man/Rlibeemd.Rd index 028eada..0a48f6e 100644 --- a/man/Rlibeemd.Rd +++ b/man/Rlibeemd.Rd @@ -3,6 +3,7 @@ \docType{package} \name{Rlibeemd} \alias{Rlibeemd} +\alias{Rlibeemd-package} \title{Rlibeemd: Ensemble empirical mode decomposition (EEMD) and its complete variant (CEEMDAN)} \description{ Package Rlibeemd contains functions for the ensemble empirical mode decomposition (EEMD),