search

ajschumacher / rjstat

read and write JSON-stat with R
Other
31 stars 6 forks source link

comply with "CRAN package maintainer check" #7

Closed ajschumacher closed 9 years ago

ajschumacher commented 9 years ago

I received this email on December 3:

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).

Please also make sure that in your package DESCRIPTION file,

* The Title field uses title case and does not end a period.  It should
  not repeat the package name, and should be on one line and preferably
  no more than 65 chars.

* The Description field really give a comprehensive description of what
  the package does, and avoids redundancies such as "This package ..."
  or "An R package for ...".

Please do *not* reply to this message.

Best,
-k

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

--- CRAN_policies.txt.prev      2014-12-02 12:23:10.639026523 +0100
+++ CRAN_policies.txt   2014-12-02 12:24:00.707024752 +0100
@@ -1,4 +1,4 @@
-                       Version $Revision: 3099 $
+                       Version $Revision: 3184 $

                       CRAN Repository Maintainers

@@ -38,17 +38,22 @@
      R itself), care must be taken that any copyright/license statements
      are preserved and authorship is not misrepresented.

-     Where copyrights are held by an entity other than the authors, the
-     'Authors@R' field can be used, or a 'Copyright' field (if necessary
+     Preferably, an 'Authors@R' would be used with 'ctb' roles for the
+     authors of such code.  Alternatively, the 'Author' field should
+     list these authors as contributors.
+
+     Where copyrights are held by an entity other than the package
+     authors, this should preferably be indicated via 'cph' roles in the
+     'Authors@R' field, or using a 'Copyright' field (if necessary
      referring to an 'inst/COPYRIGHTS' file).

      Trademarks must be respected.

    * The package's 'DESCRIPTION' file must show both the name and email
-     address of a single designated maintainer (not a mailing list).
-     That contact address must be kept up to date, and be usable for
-     information mailed by the CRAN team without any form of filtering,
-     confirmation ...
+     address of a single designated maintainer (a person, not a mailing
+     list).  That contact address must be kept up to date, and be usable
+     for information mailed by the CRAN team without any form of
+     filtering, confirmation ...

      The maintainer warrants that (s)he is acting on behalf of all
      credited authors and has their agreement to use their material in
@@ -66,8 +71,10 @@
    * Source packages under an Open Source license must provide source or
      something which can easily be converted back to source (e.g.,
      '.rda' files) for all components of the package (including for
-     example PDF documentation and configure files produced by
-     'autoconf').
+     example PDF documentation, configure files produced by 'autoconf').
+     For Java '.class' and '.jar' files, the sources should be in a
+     top-level 'java' directory in the source package (or that directory
+     should explain how they can be obtained).

      Such packages are not permitted to require (e.g., by specifying in
      'Depends', 'Imports' or 'LinkingTo' fields) directly or indirectly
@@ -205,7 +212,7 @@

    * Changes to CRAN packages causing significant disruption to other
      packages must be agreed with the CRAN maintainers well in advance
-     of any publicity.  Introduction of new packages providing
+     of any publicity.  Introduction of packages providing
      back-compatibility versions of already available packages is not
      allowed.

@@ -237,17 +244,13 @@
 Submission
 **********

-When submitting a package to CRAN you should *either*
-
-   * use the submission form at <http://CRAN.R-project.org/submit.html>
-     (and not send an email).  You will be sent a confirmation email
-     which needs to be accepted.
-
-     *or*
-
-   * upload by anonymous 'ftp' to <ftp://CRAN.R-project.org/incoming/>
-     and send a (plain text ASCII) email at the same time, with subject
-     line as specified below.
+When submitting a package to CRAN you should use the submission form at
+<http://CRAN.R-project.org/submit.html> (and not send an email).  You
+will be sent a confirmation email which needs to be accepted.
+
+   If this fails, upload by anonymous 'ftp' to
+<ftp://CRAN.R-project.org/incoming/> and send a (plain text ASCII) email
+at the same time, with subject line as specified below.

    In either case, you can check that the submission was received by
 looking at <ftp://CRAN.R-project.org/incoming/>.
@@ -259,8 +262,9 @@

    * Please ensure that 'R CMD check --as-cran' has been run _on the
      tarball to be uploaded_ before submission.  This should be done
-     with the current version of R-devel (or if that is not possible,
-     current R-patched or the current release of R.)
+     with the current version of R-devel (or if that is not possible and
+     explained in the submission, current R-patched or the current
+     release of R.)

      In principle, packages must pass 'R CMD check' without warnings or
      significant notes to be admitted to the main CRAN package area.  If
@@ -271,9 +275,11 @@

    * For a package update, please check that any packages depending on
      this one still pass 'R CMD check': it is especially expected that
-     you will have checked your own packages.  A listing of the reverse
-     dependencies of the current version can be found on the CRAN web
-     page for the package.
+     you will have checked your own packages.  Reverse dependencies can
+     conveniently be checked using 'tools::check_packages_in_dir(reverse
+     = list())'.  A listing of the reverse dependencies of the current
+     version can be found on the CRAN web page for the package, or be
+     obtained via 'tools::package_dependencies(reverse = TRUE)'.

    * An 'ftp' upload should be accompanied by an email to
      <CRAN@R-project.org> sent from the maintainer address listed in the
ajschumacher commented 9 years ago

I think the only thing here that might not be perfect is the bit about using title case for the title. I think the current title is Close Enough to title case.