fix URLs & typos; mention recalibration & planned update

git-svn-id: https://svn.r-project.org/R/trunk@87301 00db46b3-68df-0310-9c12-caf00c1e9a41

Author: maechler

doc/NEWS.Rd

@@ -363,6 +363,9 @@
       \item \code{kappa(A, exact=TRUE)} for singular \code{A} returns
       \code{Inf} more generally, fixing \PR{18817} reported by
       \I{Mikael Jagan}.
+
+      \item Fixed URLs of the sun spots (\code{sunspot.month} etc) data
+      sets and mention future changes due to recalibration.
     }
   }
 }

src/library/datasets/man/sunspot.month.Rd

@@ -1,12 +1,13 @@
 % File src/library/datasets/man/sunspot.month.Rd
 % Part of the R package, https://www.R-project.org
-% Copyright 1995-2014 R Core Team
+% Copyright 1995-2024 R Core Team
 % Distributed under GPL 2 or later
 
 \name{sunspot.month}
+\title{Monthly Sunspot Data, from 1749 to "Present"}
 \docType{data}
+\encoding{UTF-8}
 \alias{sunspot.month}
-\title{Monthly Sunspot Data, from 1749 to "Present"}
 \description{
   Monthly numbers of sunspots, as from the World Data Center, aka \abbr{SIDC}.
   This is the version of the data that will occasionally be updated when
@@ -17,27 +18,45 @@ sunspot.month
 }
 \format{
   The univariate time series \code{sunspot.year} and
-  \code{sunspot.month} contain 289 and 2988 observations, respectively.
-  The objects are of class \code{"ts"}.
+  \code{sunspot.month} contain 289 and
+  3177
+  observations, respectively, where the latter will increase over time.
+  The objects are of class \code{"\link{ts}"}.
 }
 \seealso{
-  \code{sunspot.month} is a longer version of \code{\link{sunspots}};
+  \code{sunspot.month} is a more up-to-date and hence also longer version of
+  \code{\link{sunspots}};
   the latter runs until 1983 and is kept fixed (for reproducibility as example
   dataset).
 }
 \source{
   \I{WDC-SILSO}, Solar Influences Data Analysis Center (\abbr{SIDC}),
   Royal Observatory of Belgium, Av. Circulaire, 3, B-1180 BRUSSELS
-  Currently at \url{http://www.sidc.be/silso/datafiles}% was http://sidc.oma.be/sunspot-data/
+  Currently at \url{https://www.sidc.be/SILSO/datafiles}% was
+  % http://www.sidc.be/silso/datafiles, and http://sidc.oma.be/sunspot-data/
+
+  From around 2015, expert astronomers decided to recalibrate historical sunspot
+  numbers, see the \sQuote{References}.
+  This is \emph{not yet} visible in current \code{sunspot.month} but
+  may well change by the next release of \R.
+}
+\references{
+  Clette, \enc{Frédéric}{Frederic} and \enc{Lefèvre}{Lefevre}, Laure (2016)
+  The New Sunspot Number: Assembling All Corrections.
+  \emph{Solar Physics} \bold{291}, 2629--2651. \doi{10.1007/s11207-016-1014-y}
+
+  Clette, F.,  \enc{Lefèvre}{Lef`evre}, L.,  Chatzistergos, T. et al. (2023)
+  Recalibration of the Sunspot-Number: Status Report.
+  \emph{Solar Physics} \bold{298}: 44.  \doi{10.1007/s11207-023-02136-3}
 }
 \author{
-  R
+  R Core Team.
 }
 \examples{
 require(stats); require(graphics)
 ## Compare the monthly series
 plot (sunspot.month,
-      main="sunspot.month & sunspots [package'datasets']", col=2)
+      main="sunspot.month & sunspots [package 'datasets']", col=2)
 lines(sunspots) # -> faint differences where they overlap
 
 ## Now look at the difference :
@@ -60,5 +79,6 @@ cbind(i = i, time = time(sunspots)[i], sunspots = s1, ss.month = s2,
 ssm0 <- sunspot.month[1:2988]
 with(as.data.frame(.sunspot.diff), ssm0[i] <<- ssm0[i] - res10/10)
 sunspot.month.0 <- ts(ssm0, start = 1749, frequency = 12)
+stopifnot(length(sunspot.month.0) == 2988)
 }
 \keyword{datasets}

src/library/datasets/man/sunspot.year.Rd

@@ -1,6 +1,6 @@
 % File src/library/datasets/man/sunspot.year.Rd
 % Part of the R package, https://www.R-project.org
-% Copyright 1995-2007 R Core Team
+% Copyright 1995-2024 R Core Team
 % Distributed under GPL 2 or later
 
 \name{sunspot.year}
@@ -30,16 +30,16 @@ sunspot.year
 
   Regularly updated yearly sunspot numbers are available from
   \I{WDC-SILSO}, Royal Observatory of Belgium, at
-  \url{http://www.sidc.be/silso/datafiles}
+  \url{https://www.sidc.be/SILSO/datafiles}% was http://www.sidc.be/silso/datafiles
 }
 \examples{
 utils::str(sm <- sunspots)# the monthly version we keep unchanged
 utils::str(sy <- sunspot.year)
 ## The common time interval
 (t1 <- c(max(start(sm), start(sy)),     1)) # Jan 1749
-(t2 <- c(min(  end(sm)[1],end(sy)[1]), 12)) # Dec 1983
+(t2 <- c(min(  end(sm)[1],end(sy)[1]), 12)) # Dec 1983 (will not be updated!)
 s.m <- window(sm, start=t1, end=t2)
-s.y <- window(sy, start=t1, end=t2[1]) # {irrelevant warning}
+s.y <- window(sy, start=t1, end=t2[1])
 stopifnot(length(s.y) * 12 == length(s.m),
           ## The yearly series *is* close to the averages of the monthly one:
           all.equal(s.y, aggregate(s.m, FUN = mean), tolerance = 0.0020))