diff --git a/CRAN-RELEASE b/CRAN-RELEASE new file mode 100644 index 0000000..5c495a8 --- /dev/null +++ b/CRAN-RELEASE @@ -0,0 +1,2 @@ +This package was submitted to CRAN on 2021-02-13. +Once it is accepted, delete this file and tag the release (commit abd4bbd9c9). diff --git a/DESCRIPTION b/DESCRIPTION index 8d41962..5af243e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -13,7 +13,7 @@ Description: Optimized prediction based on textual sentiment, accounting for the Depends: R (>= 3.3.0) License: GPL (>= 2) BugReports: https://github.com/SentometricsResearch/sentometrics/issues -URL: https://SentometricsResearch.github.io/sentometrics +URL: https://sentometrics-research.com/sentometrics/ Encoding: UTF-8 LazyData: true Suggests: covr, diff --git a/R/sentometrics.R b/R/sentometrics.R index b3c51ac..2ac2543 100644 --- a/R/sentometrics.R +++ b/R/sentometrics.R @@ -26,10 +26,10 @@ #' #' @references Ardia, Bluteau and Boudt (2019). \strong{Questioning the news about economic growth: Sparse forecasting using #' thousands of news-based sentiment values}. \emph{International Journal of Forecasting 35, 1370-1386}, -#' \url{https://doi.org/10.1016/j.ijforecast.2018.10.010}. +#' \doi{10.1016/j.ijforecast.2018.10.010}. #' @references Ardia, Bluteau, Borms and Boudt (2020). \strong{The R package sentometrics to compute, aggregate and #' predict with textual sentiment}. \emph{Forthcoming in Journal of Statistical Software}, -#' \url{https://doi.org/10.2139/ssrn.3067734}. +#' \doi{10.2139/ssrn.3067734}. "_PACKAGE" #' Built-in lexicons @@ -72,17 +72,17 @@ #' @format A \code{list} with all built-in lexicons, appropriately named as \code{"NAME_language(_tr)"} . #' #' @references Abdaoui, \enc{Azé}{Aze}, Bringay and Poncelet (2017). \strong{FEEL: French Expanded Emotion Lexicon}. -#' \emph{Language Resources & Evaluation 51, 833-855}, \url{https://doi.org/10.1007/s10579-016-9364-5}. +#' \emph{Language Resources & Evaluation 51, 833-855}, \doi{10.1007/s10579-016-9364-5}. #' @references Henry (2008). \strong{Are investors influenced by how earnings press releases are written?}. -#' \emph{Journal of Business Communication 45, 363-407}, \url{https://doi.org/10.1177/0021943608319388}. +#' \emph{Journal of Business Communication 45, 363-407}, \doi{10.1177/0021943608319388}. #' @references Loughran and McDonald (2011). \strong{When is a liability not a liability? Textual analysis, dictionaries, and 10-Ks}. -#' \emph{Journal of Finance 66, 35-65}, \url{https://doi.org/10.1111/j.1540-6261.2010.01625.x}. +#' \emph{Journal of Finance 66, 35-65}, \doi{10.1111/j.1540-6261.2010.01625.x}. #' #' @source \href{https://doi.org/10.1007/s10579-016-9364-5}{FEEL lexicon}. Retrieved November 1, 2017. #' @source \href{http://www.wjh.harvard.edu/~inquirer/spreadsheet_guide.htm}{GI lexicon}. Retrieved November 1, 2017. #' @source \href{https://doi.org/10.1177/0021943608319388}{HENRY lexicon}. Retrieved #' November 1, 2017. -#' @source \href{https://sraf.nd.edu/textual-analysis/resources}{LM lexicon}. Retrieved +#' @source \href{https://sraf.nd.edu/textual-analysis/resources/}{LM lexicon}. Retrieved #' November 1, 2017. "list_lexicons" @@ -176,7 +176,7 @@ #' @format A \code{data.frame} with 403 rows and 4 columns. #' #' @references Baker, Bloom and Davis (2016). \strong{Measuring Economic Policy Uncertainty}. -#' \emph{The Quarterly Journal of Economics 131, 1593-1636}, \url{https://doi.org/10.1093/qje/qjw024}. +#' \emph{The Quarterly Journal of Economics 131, 1593-1636}, \doi{10.1093/qje/qjw024}. #' #' @source \href{http://www.policyuncertainty.com/us_monthly.html}{Measuring Economic Policy Uncertainty}. Retrieved #' August 24, 2018. diff --git a/R/sentomodel.R b/R/sentomodel.R index 98e5a3a..de4f99e 100644 --- a/R/sentomodel.R +++ b/R/sentomodel.R @@ -61,9 +61,9 @@ #' @seealso \code{\link{sento_model}} #' #' @references Tibshirani and Taylor (2012). \strong{Degrees of freedom in LASSO problems}. -#' \emph{The Annals of Statistics 40, 1198-1232}, \url{https://doi.org/10.1214/12-AOS1003}. +#' \emph{The Annals of Statistics 40, 1198-1232}, \doi{10.1214/12-AOS1003}. #' @references Zou, Hastie and Tibshirani (2007). \strong{On the degrees of freedom of the LASSO}. -#' \emph{The Annals of Statistics 35, 2173-2192}, \url{https://doi.org/10.1214/009053607000000127}. +#' \emph{The Annals of Statistics 35, 2173-2192}, \doi{10.1214/009053607000000127}. #' #' @examples #' # information criterion based model control functions @@ -806,7 +806,7 @@ predict.sento_model <- function(object, newx, type = "response", offset = NULL, #' @seealso \code{\link{sento_model}}, \code{\link[MCS]{MCSprocedure}} #' #' @references Hansen, Lunde and Nason (2011). \strong{The model confidence set}. \emph{Econometrica 79, 453-497}, -#' \url{https://doi.org/10.3982/ECTA5771}. +#' \doi{10.3982/ECTA5771}. #' #' @examples #' \dontrun{ diff --git a/R/utils.R b/R/utils.R index b657c70..3c357f6 100644 --- a/R/utils.R +++ b/R/utils.R @@ -108,7 +108,7 @@ weights_almon <- function(n, orders = 1:3, do.inverse = TRUE, do.normalize = TRU #' @seealso \code{\link{ctr_agg}} #' #' @references Ghysels, Sinko and Valkanov (2007). \strong{MIDAS regressions: Further results and new directions}. -#' \emph{Econometric Reviews 26, 53-90}, \url{https://doi.org/10.1080/07474930600972467}. +#' \emph{Econometric Reviews 26, 53-90}, \doi{10.1080/07474930600972467}. #' #' @export weights_beta <- function(n, a = 1:4, b = 1:4, do.normalize = TRUE) { @@ -165,7 +165,7 @@ setup_time_weights <- function(how, param) { #' \code{\link{ctr_agg}} to check if supplied aggregation hows are supported. #' #' @details -#' See the package's \href{https://ssrn.com/abstract=3067734}{vignette} for a detailed explanation of all +#' See the package's \href{https://www.ssrn.com/abstract=3067734}{vignette} for a detailed explanation of all #' aggregation options. #' # Weighting within documents or sentences (\code{"words"}): diff --git a/README.md b/README.md index 67eaedc..386a297 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ - + ## _sentometrics_: An Integrated Framework for Textual Sentiment Time Series Aggregation and Prediction -[![CRAN](http://www.r-pkg.org/badges/version/sentometrics)](https://cran.r-project.org/package=sentometrics) +[![CRAN](https://www.r-pkg.org/badges/version/sentometrics)](https://cran.r-project.org/package=sentometrics) +[![Downloads](https://cranlogs.r-pkg.org/badges/last-day/sentometrics?color=ff69b4)](https://www.r-pkg.org/pkg/sentometrics) +[![Downloads](https://cranlogs.r-pkg.org/badges/sentometrics?color=ff69b4)](https://www.r-pkg.org/pkg/sentometrics) +[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/sentometrics?color=ff69b4)](https://www.r-pkg.org/pkg/sentometrics) -[![Downloads](http://cranlogs.r-pkg.org/badges/last-day/sentometrics?color=ff69b4)](http://www.r-pkg.org/pkg/sentometrics) -[![Downloads](http://cranlogs.r-pkg.org/badges/sentometrics?color=ff69b4)](http://www.r-pkg.org/pkg/sentometrics) -[![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/sentometrics?color=ff69b4)](http://www.r-pkg.org/pkg/sentometrics) - - + + ### Introduction The **`sentometrics`** package is an **integrated framework for textual sentiment time series aggregation and prediction**. It accounts for the intrinsic challenge that textual sentiment can be computed in many different ways, as well as the large number of possibilities to pool sentiment into a time series index. The package integrates the fast _quantification_ of sentiment from texts, the _aggregation_ into different sentiment time series, and the _prediction_ based on these measures. All in one coherent workflow! -See the [package website](https://SentometricsResearch.github.io/sentometrics) and the [vignette](https://doi.org/10.2139/ssrn.3067734) for plenty of examples and details. We also refer to this [survey](https://doi.org/10.1111/joes.12370) organized as an overview of the required steps in a typical econometric analysis of sentiment from alternative (such as textual) data, and following companion [web page](https://sborms.github.io/econometrics-meets-sentiment). +See the [package website](https://SentometricsResearch.github.io/sentometrics) and the [vignette](https://doi.org/10.2139/ssrn.3067734) for plenty of examples and details. We also refer to this [survey](https://doi.org/10.1111/joes.12370) organized as an overview of the required steps in a typical econometric analysis of sentiment from alternative (such as textual) data, and following companion [web page](https://sborms.github.io/econometrics-meets-sentiment/). ### Installation @@ -46,5 +46,5 @@ Please cite **`sentometrics`** in publications. Use `citation("sentometrics")`. This software package originates from a [Google Summer of Code 2017](https://github.com/rstats-gsoc/gsoc2017/wiki/Sentometrics:-An-integrated-framework-for-text-based-multivariate-time-series-modeling-and-forecasting) project, was further developed -during a follow-up [Google Summer of Code 2019](https://github.com/rstats-gsoc/gsoc2019/wiki/sentometrics) project, and benefited generally from financial support by [Innoviris](https://innoviris.brussels), [IVADO](https://www.ivado.ca), [swissuniversities](https://www.swissuniversities.ch), and the [Swiss National Science Foundation](http://www.snf.ch) (grants #179281 and #191730). +during a follow-up [Google Summer of Code 2019](https://github.com/rstats-gsoc/gsoc2019/wiki/sentometrics) project, and benefited generally from financial support by [Innoviris](https://innoviris.brussels), [IVADO](https://ivado.ca/), [swissuniversities](https://www.swissuniversities.ch), and the [Swiss National Science Foundation](http://www.snf.ch) (grants #179281 and #191730). diff --git a/cran-comments.md b/cran-comments.md index d59da6b..ce6dbf6 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,9 +1,13 @@ -## submission (version 0.8.3) [13/02/2021] +## resubmission (version 0.8.3) [15/02/2021] + +- adjusted some URL and doi links + + -[![CRAN](http://www.r-pkg.org/badges/version/sentometrics)](https://cran.r-project.org/package=sentometrics) +[![CRAN](https://www.r-pkg.org/badges/version/sentometrics)](https://cran.r-project.org/package=sentometrics) [![codecov](https://codecov.io/github/SentometricsResearch/sentometrics/branch/master/graphs/badge.svg)](https://codecov.io/github/SentometricsResearch/sentometrics) -[![Downloads](http://cranlogs.r-pkg.org/badges/last-day/sentometrics?color=ff69b4)](http://www.r-pkg.org/pkg/sentometrics) -[![Downloads](http://cranlogs.r-pkg.org/badges/sentometrics?color=ff69b4)](http://www.r-pkg.org/pkg/sentometrics) -[![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/sentometrics?color=ff69b4)](http://www.r-pkg.org/pkg/sentometrics) +[![Downloads](https://cranlogs.r-pkg.org/badges/last-day/sentometrics?color=ff69b4)](https://www.r-pkg.org/pkg/sentometrics) +[![Downloads](https://cranlogs.r-pkg.org/badges/sentometrics?color=ff69b4)](https://www.r-pkg.org/pkg/sentometrics) +[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/sentometrics?color=ff69b4)](https://www.r-pkg.org/pkg/sentometrics) # sentometrics diff --git a/man/ctr_model.Rd b/man/ctr_model.Rd index 462190f..11ffc2f 100644 --- a/man/ctr_model.Rd +++ b/man/ctr_model.Rd @@ -116,10 +116,10 @@ ctrCV4 <- ctr_model(model = "gaussian", type = "cv", do.iter = TRUE, h = 0, trai } \references{ Tibshirani and Taylor (2012). \strong{Degrees of freedom in LASSO problems}. -\emph{The Annals of Statistics 40, 1198-1232}, \url{https://doi.org/10.1214/12-AOS1003}. +\emph{The Annals of Statistics 40, 1198-1232}, \doi{10.1214/12-AOS1003}. Zou, Hastie and Tibshirani (2007). \strong{On the degrees of freedom of the LASSO}. -\emph{The Annals of Statistics 35, 2173-2192}, \url{https://doi.org/10.1214/009053607000000127}. +\emph{The Annals of Statistics 35, 2173-2192}, \doi{10.1214/009053607000000127}. } \seealso{ \code{\link{sento_model}} diff --git a/man/epu.Rd b/man/epu.Rd index 4568b89..39371b9 100644 --- a/man/epu.Rd +++ b/man/epu.Rd @@ -35,6 +35,6 @@ head(epu) } \references{ Baker, Bloom and Davis (2016). \strong{Measuring Economic Policy Uncertainty}. -\emph{The Quarterly Journal of Economics 131, 1593-1636}, \url{https://doi.org/10.1093/qje/qjw024}. +\emph{The Quarterly Journal of Economics 131, 1593-1636}, \doi{10.1093/qje/qjw024}. } \keyword{datasets} diff --git a/man/get_hows.Rd b/man/get_hows.Rd index 63ddb12..36c5ed9 100644 --- a/man/get_hows.Rd +++ b/man/get_hows.Rd @@ -15,7 +15,7 @@ Outputs the supported aggregation arguments. Call for information purposes only. \code{\link{ctr_agg}} to check if supplied aggregation hows are supported. } \details{ -See the package's \href{https://ssrn.com/abstract=3067734}{vignette} for a detailed explanation of all +See the package's \href{https://www.ssrn.com/abstract=3067734}{vignette} for a detailed explanation of all aggregation options. } \seealso{ diff --git a/man/get_loss_data.Rd b/man/get_loss_data.Rd index 5db918b..589e290 100644 --- a/man/get_loss_data.Rd +++ b/man/get_loss_data.Rd @@ -64,7 +64,7 @@ mcs <- MCS::MCSprocedure(lossData)} } \references{ Hansen, Lunde and Nason (2011). \strong{The model confidence set}. \emph{Econometrica 79, 453-497}, -\url{https://doi.org/10.3982/ECTA5771}. +\doi{10.3982/ECTA5771}. } \seealso{ \code{\link{sento_model}}, \code{\link[MCS]{MCSprocedure}} diff --git a/man/list_lexicons.Rd b/man/list_lexicons.Rd index 3d8ca79..87d9181 100644 --- a/man/list_lexicons.Rd +++ b/man/list_lexicons.Rd @@ -15,7 +15,7 @@ A \code{list} with all built-in lexicons, appropriately named as \code{"NAME_lan \href{https://doi.org/10.1177/0021943608319388}{HENRY lexicon}. Retrieved November 1, 2017. -\href{https://sraf.nd.edu/textual-analysis/resources}{LM lexicon}. Retrieved +\href{https://sraf.nd.edu/textual-analysis/resources/}{LM lexicon}. Retrieved November 1, 2017. } \usage{ @@ -55,12 +55,12 @@ list_lexicons[c("FEEL_en_tr", "LM_en")] } \references{ Abdaoui, \enc{Azé}{Aze}, Bringay and Poncelet (2017). \strong{FEEL: French Expanded Emotion Lexicon}. -\emph{Language Resources & Evaluation 51, 833-855}, \url{https://doi.org/10.1007/s10579-016-9364-5}. +\emph{Language Resources & Evaluation 51, 833-855}, \doi{10.1007/s10579-016-9364-5}. Henry (2008). \strong{Are investors influenced by how earnings press releases are written?}. -\emph{Journal of Business Communication 45, 363-407}, \url{https://doi.org/10.1177/0021943608319388}. +\emph{Journal of Business Communication 45, 363-407}, \doi{10.1177/0021943608319388}. Loughran and McDonald (2011). \strong{When is a liability not a liability? Textual analysis, dictionaries, and 10-Ks}. -\emph{Journal of Finance 66, 35-65}, \url{https://doi.org/10.1111/j.1540-6261.2010.01625.x}. +\emph{Journal of Finance 66, 35-65}, \doi{10.1111/j.1540-6261.2010.01625.x}. } \keyword{datasets} diff --git a/man/sentometrics-package.Rd b/man/sentometrics-package.Rd index 1ea6959..5eaf84e 100644 --- a/man/sentometrics-package.Rd +++ b/man/sentometrics-package.Rd @@ -35,16 +35,16 @@ Please cite the package in publications. Use \code{citation("sentometrics")}. \references{ Ardia, Bluteau and Boudt (2019). \strong{Questioning the news about economic growth: Sparse forecasting using thousands of news-based sentiment values}. \emph{International Journal of Forecasting 35, 1370-1386}, -\url{https://doi.org/10.1016/j.ijforecast.2018.10.010}. +\doi{10.1016/j.ijforecast.2018.10.010}. Ardia, Bluteau, Borms and Boudt (2020). \strong{The R package sentometrics to compute, aggregate and predict with textual sentiment}. \emph{Forthcoming in Journal of Statistical Software}, -\url{https://doi.org/10.2139/ssrn.3067734}. +\doi{10.2139/ssrn.3067734}. } \seealso{ Useful links: \itemize{ - \item \url{https://SentometricsResearch.github.io/sentometrics} + \item \url{https://sentometrics-research.com/sentometrics/} \item Report bugs at \url{https://github.com/SentometricsResearch/sentometrics/issues} } diff --git a/man/weights_beta.Rd b/man/weights_beta.Rd index 2412c5e..578e320 100644 --- a/man/weights_beta.Rd +++ b/man/weights_beta.Rd @@ -33,7 +33,7 @@ the \code{\link{gamma}} function. } \references{ Ghysels, Sinko and Valkanov (2007). \strong{MIDAS regressions: Further results and new directions}. -\emph{Econometric Reviews 26, 53-90}, \url{https://doi.org/10.1080/07474930600972467}. +\emph{Econometric Reviews 26, 53-90}, \doi{10.1080/07474930600972467}. } \seealso{ \code{\link{ctr_agg}}