[R-pkg-devel] CRAN submission struggle

[Christiaan Pieterse]

Good day fellow developers!

I am trying to upload a package to CRAN that I developed.
I've tried before to upload it but ended up with a package file that is a
complete mess so I decided to restart.
Here are the steps I followed when I created my file:

   1. Created a folder on my desktop called "iopspackage".
   2. Created a subfolder called 'R' which contained my .R package. This .R
   file contained the Roxygen2 comments. (I was very unsure what comments to
   include in this so it might be wrong, I'm unsure)
   3. Included a DESCRIPTION file is the 'iopspackage' folder. (Once again
   I was very unsure what to include in this file so it might be wrong).
   4. My package requires a dataset in order to run the example so I
   created a file and sub file called 'inst'/'extdata' which contained the
   .csv datasets.
   5. Created an empty 'man' folder to be populated when the Roxygen2
   function is run.
   6. I ran the Roxygen2 function with the correct directory, using
   roxygen2::roxygenize()
   7. I built the package using *R CMD build
   "C:/Users/pieti/Desktop/iopspackage".*
   8. I checked the tar file using *R CMD check --as-cran
   "iopspackage_2.1.0.tar.gz". *This yielded errors, warnings and notes
   which I don't know how to solve and suspect are due to me setting the file
   up wrong.

I've been told before not to include my package as an attachment, so can
someone please help me with the submission process? I've been struggling
with this for months. Any help would be greatly appreciated.
I can send my zip file over a private email so as not to disturb all the
developers and their storage space (It is a 10mb file)

Kind regards
Christiaan

[[alternative HTML version deleted]]

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Re: [R-pkg-devel] CRAN submission struggle

[Roy Mendelssohn - NOAA Federal via R-package-devel]

> On Dec 16, 2023, at 9:41 AM, Christiaan Pieterse  
> wrote:
> 
>  I checked the tar file using *R CMD check --as-cran
>   "iopspackage_2.1.0.tar.gz". *This yielded errors, warnings and notes
>   which I don't know how to solve and suspect are due to me setting the file
>   up wrong.

A good start might be to provide the "errors, warnings and notes"

Thanks,

-Roy
**
"The contents of this message do not reflect any position of the U.S. 
Government or NOAA."
**
Roy Mendelssohn
Supervisory Operations Research Analyst
NOAA/NMFS
Environmental Research Division
Southwest Fisheries Science Center
***Note new street address***
110 McAllister Way
Santa Cruz, CA 95060
Phone: (831)-420-3666
Fax: (831) 420-3980
e-mail: roy.mendelss...@noaa.gov www: https://www.pfeg.noaa.gov/

"Old age and treachery will overcome youth and skill."
"From those who have been given much, much will be expected" 
"the arc of the moral universe is long, but it bends toward justice" -MLK Jr.

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Re: [R-pkg-devel] CRAN submission struggle

[Dirk Eddelbuettel]

Christiaan,

You say "errors" but you don't say which.

You say you have a package, but don't provide a source reference.

This makes it awfully hard to say or do anything. In case you are on github
or gitlab or ... it would simply be easiest to share a reference to the
repository.  Emailing 10mb blobs to every list subscriber is not ideal.

Dirk

PS Fortunes has that covered too

   > fortunes::fortune("mind read")

   There are actual error messages, and until you show them, we can not help as 
the mind
   reading machine is currently off for repairs.
  -- Dirk Eddelbuettel (after reports about errors with R CMD check)
 R-help (July 2010)

   > 
-- 
dirk.eddelbuettel.com | @eddelbuettel | e...@debian.org

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Re: [R-pkg-devel] CRAN submission struggle

[Roy Mendelssohn - NOAA Federal via R-package-devel]

And a second good starting place would be:

https://r-pkgs.org

HTH,

-Roy

> On Dec 16, 2023, at 9:48 AM, Roy Mendelssohn - NOAA Federal 
>  wrote:
> 
> 
> 
>> On Dec 16, 2023, at 9:41 AM, Christiaan Pieterse  
>> wrote:
>> 
>> I checked the tar file using *R CMD check --as-cran
>>  "iopspackage_2.1.0.tar.gz". *This yielded errors, warnings and notes
>>  which I don't know how to solve and suspect are due to me setting the file
>>  up wrong.
> 
> A good start might be to provide the "errors, warnings and notes"
> 
> Thanks,
> 
> -Roy
> **
> "The contents of this message do not reflect any position of the U.S. 
> Government or NOAA."
> **
> Roy Mendelssohn
> Supervisory Operations Research Analyst
> NOAA/NMFS
> Environmental Research Division
> Southwest Fisheries Science Center
> ***Note new street address***
> 110 McAllister Way
> Santa Cruz, CA 95060
> Phone: (831)-420-3666
> Fax: (831) 420-3980
> e-mail: roy.mendelss...@noaa.gov www: https://www.pfeg.noaa.gov/
> 
> "Old age and treachery will overcome youth and skill."
> "From those who have been given much, much will be expected" 
> "the arc of the moral universe is long, but it bends toward justice" -MLK Jr.
> 

**
"The contents of this message do not reflect any position of the U.S. 
Government or NOAA."
**
Roy Mendelssohn
Supervisory Operations Research Analyst
NOAA/NMFS
Environmental Research Division
Southwest Fisheries Science Center
***Note new street address***
110 McAllister Way
Santa Cruz, CA 95060
Phone: (831)-420-3666
Fax: (831) 420-3980
e-mail: roy.mendelss...@noaa.gov www: https://www.pfeg.noaa.gov/

"Old age and treachery will overcome youth and skill."
"From those who have been given much, much will be expected" 
"the arc of the moral universe is long, but it bends toward justice" -MLK Jr.

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Re: [R-pkg-devel] CRAN submission struggle

[Ivan Krylov]

On Sat, 16 Dec 2023 19:41:16 +0200
Christiaan Pieterse  wrote:

> This .R file contained the Roxygen2 comments. (I was very unsure what
> comments to include in this so it might be wrong, I'm unsure)

If you like roxygen2 and would like to keep using it, you're welcome to
keep the roxygen2 comments in your R files. Just don't forget to re-run
roxygenise() every time you update them.

>3. Included a DESCRIPTION file is the 'iopspackage' folder. (Once
> again I was very unsure what to include in this file so it might be
> wrong).

Does it help to follow the guide at
?
Start with the mandatory fields Package, Version, License,
Description, Title and Authors@R (to generate Author: and Maintainer:
from).

>8. I checked the tar file using *R CMD check --as-cran
>"iopspackage_2.1.0.tar.gz". *This yielded errors, warnings and
> notes which I don't know how to solve and suspect are due to me
> setting the file up wrong.

Can you show us the log from the check? It should be fine to copy &
paste the entries that don't say OK (i.e. NOTEs, WARNINGs, and ERRORs).

Most of what you'll need to fix is described in "Writing R Extensions"
(link above) and the CRAN policy at
.

> I've been told before not to include my package as an attachment, so
> can someone please help me with the submission process?

Can you publish the code anywhere? Ideally, this place should provide
instant access to the latest version of every source code file inside
your package. The most popular option nowadays is GitHub, but it does
not have to be GitHub. Two GDPR-friendly alternatives are Codeberg and
SourceHut. If you don't like Git (which does take effort to learn),
there's R-Forge and Chiselapp.com. If you don't want to learn software
version control right now, any free web/file hosting will suffice as
long as you keep the files updated and accessible.

> It is a 10mb file

I think we've discussed this before. A 10-megabyte package mostly
consisting of example data is not a good fit for CRAN. It's possible to
use free Web hosting services to distribute data packages (see the
'drat' package and the function tools::writePACKAGES) separate from the
CRAN package that should mainly contain the code.

-- 
Best regards,
Ivan

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel