[GenABEL-dev] Fwd: CRAN package maintainer check

Wed Dec 11 13:58:41 CET 2013

FYI

Some of the points (eg API) are highly relevant to us as far as I can see

----------------------
Yurii Aulchenko
(sent from mobile device)

Begin forwarded message:

*From:* Kurt Hornik <Kurt.Hornik at wu.ac.at>
*Date:* December 11, 2013 at 12:26:34 GMT+1
*To:* Kurt Hornik <Kurt.Hornik at wu.ac.at>
*Cc:* Brian Ripley <ripley at stats.ox.ac.uk>, Uwe Ligges <
uwe.ligges at tu-dortmund.de>
*Subject:* *CRAN package maintainer check*
*Reply-To:* Kurt.Hornik at wu.ac.at


Dear CRAN package maintainer,

We email all CRAN maintainers periodically to check that the email
address is still active and to remind them of the CRAN policies at
<http://CRAN.R-project.org/web/packages/policies.html>.

Changes to those policies in the last 4 months are given below.

Please check whether your maintainer address needs updating (in
particular in case you moved, or received multiple copies of this
message).

Best,
-k

***********************************************************************

Index: CRAN_policies.texi
===================================================================

--- CRAN_policies.texi    (revision 2906)
+++ CRAN_policies.texi    (working copy)
@@ -236,15 +236,23 @@
into which they are loaded.

@item
- at acronym{CRAN} packages should use only the public API.  Hence they should
-not use entry points not declared as API in installed headers nor
- at code{.Internal()} nor @code{.Call()} etc calls to base packages.  Such
-usages can cause packages to break at any time, even in patched versions
-of R.
+ at acronym{CRAN} packages should use only the public API.  Hence they
+should not use entry points not declared as API in installed headers nor
+ at code{.Internal()} nor @code{.Call()} etc calls to base packages. Also,
+ at code{:::} should not be used to access undocumented/internal functions
+in base packages.  Such usages can cause packages to break at any time,
+even in patched versions of R.

+ at end itemize

+ at item
+Changes to @acronym{CRAN} packages causing significant disruption to
+other packages must be agreed with the @acronym{CRAN} maintainers well
+in advance of any publicity.  Introduction of new packages providing
+back-compatibility versions of already available packages is not
+allowed.
+
@end itemize
- at end itemize

@node Binary packages, Submission, Source packages, Top
@unnumbered Binary packages
@@ -280,12 +288,16 @@
@node Submission,  , Binary packages, Top
@unnumbered Submission

-When submitting a package to CRAN you should either
+When submitting a package to CRAN you should @strong{either}
@itemize

@item
-use the submission form at @uref{http://CRAN.R-project.org/submit.html}, or
+use the submission form at @uref{http://CRAN.R-project.org/submit.html}
+(and not send an email).  You will be sent a confirmation email which
+needs to be accepted.

+ at strong{or}
+
@item
upload by anonymous @command{ftp} to
@uref{ftp://CRAN.R-project.org/@/incoming/} and send a (plain text ASCII)
@@ -293,29 +305,28 @@

@end itemize

+In either case, you can check that the submission was received by
+looking at @uref{ftp://cran.r-project.org/incoming/}.
+
In more detail:

@itemize

@item
-Uploads must be source tarballs as created by @command{R CMD build} and
-follow the @file{@var{PACKAGE}_ at var{VERSION}.tar.gz} naming scheme.
+Uploads must be source tarballs created by @command{R CMD build} and
+following the @file{@var{PACKAGE}_ at var{VERSION}.tar.gz} naming scheme.

@item
Please ensure that @command{R CMD check --as-cran} has been run @emph{on
the tarball to be uploaded} before submission.  This should be done with
-the current release of R or (preferably) R-devel or R-patched. As
-``Writing R Extensions'' used to say
+the current version of R-devel (or if that is not possible, current
+R-patched or the current release of R.)

- at quotation
-Please ensure that you can run through the complete procedure with only
-warnings that you understand and have reasons not to eliminate.  In
-principle, packages must pass @code{R CMD check} without warnings or
+In principle, packages must pass @code{R CMD check} without warnings or
significant notes to be admitted to the main @acronym{CRAN} package
area.  If there are warnings or notes you cannot eliminate (for example
because you believe them to be spurious) send an explanatory note as
-part of your covering email.
- at end quotation
+part of your covering email, or as a comment on the submission form.

@item
For a package update, please check that any packages depending on this
@@ -325,17 +336,18 @@
for the package.

@item
-A submission upload  should be accompanied by an email to
- at email{CRAN@@R-project.org} sent from the maintainer
-address listed in the package, and  using the subject line
-`CRAN submission @var{PACKAGE} @var{VERSION}', where @var{PACKAGE} and
- at var{VERSION} are the package name and version, respectively.  Plain
-text ASCII emails should be used if at all possible.
+An @command{ftp} upload should be accompanied by an email to
+ at email{CRAN@@R-project.org} sent from the maintainer address listed in
+the package, and using the subject line `CRAN submission @var{PACKAGE}
+ at var{VERSION}', where @var{PACKAGE} and @var{VERSION} are the package
+name and version, respectively.  Plain text ASCII emails should be used
+if at all possible.

If for some reason the submission has to be made by someone else (for
example, a co-author) this needs to be explained, and the designated
maintainer will need to confirm the submission.  Explain any change in
-the maintainer's email address.
+the maintainer's email address and if possible send confirmation from
+the previous address.

For a new submission, confirm in your email that you have read and agree
to these policies.  (This includes new versions of previously archived
@@ -343,7 +355,7 @@

If the package needs special treatment (for example if vignettes can
only be run or re-built on the maintainer's machine or take a very long
-time), say so in the submission email.
+time), say so in the submission email or on the submission form.

Do not email the package itself.

@@ -373,6 +385,12 @@
writing portable packages in @url{../../doc/manuals/R-exts.html,
``Writing R Extensions''}.

+Before submitting a package update, consult the CRAN check page at
+ at uref{http://cran.r-project.org/web/checks/check_results_NAME.html},
+substituting NAME by the name of your package.  In particular, wait for
+that page to be fully updated after publication of a version (which can
+take at least 48 hours) before submitting any corrections.
+
@item
If an update will change the package's API and hence affect packages
depending on it, it is expected that you will contact the maintainers of
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/genabel-devel/attachments/20131211/757c7732/attachment.html>
