Skip to content

[R-pkg-devel] Misspelled words in descrition and tar.gz inside folder

5 messages · Edward Wei, Ivan Krylov, Spencer Graves +2 more

Original
Edward Wei
# 
Hello. Here is my "NOTE" message.

* checking CRAN incoming feasibility ... NOTE
Maintainer: ?Edward Wei <edwwei2020 at gmail.com>?

New submission

Possibly misspelled words in DESCRIPTION:
  alphavantager (8:3, 9:7)
  Alphavantager (7:32)
  api (7:58, 8:36)
  Avfintools (10:18)
  Vantager (3:55, 10:46, 11:56)

* checking top-level files ... NOTE
Non-standard file/directory found at top level:
  ?avfintools.tar.gz?

My questions are:

1. My misspelled words are just referencing names of packages and
programming terms etc. Is there a way to get around this or should I omit
them from my description and put them somewhere else.

2. I wanted to confirm this, but the tar.gz for CRAN submission SHOULD NOT
be in the folder of the directory for my package.

Thanks for your time,
Ivan Krylov
# 
On Tue, 9 Aug 2022 13:38:33 -0700
Edward Wei <edwwei2020 at gmail.com> wrote:

            

      
      
      
    

        
If you can, mention them in the comments to the CRAN submission.

            

      
      
      
    

        
Check your R CMD build process. There seemed to have been an
avfintools.tar.gz file in the package directory at the time when you
were preparing the package tarball. If you prefer to build the package
in the current directory (i.e. by running R CMD build .) or otherwise
need that file there, use .Rbuildignore to prevent it from ending up
inside the tarball. For example, you can put \.tar\.gz$ on a line there
to skip all files with names ending with .tar.gz.

  
    

      
      
    

  


  


      

    

    

      
      

        


  

        

      Spencer Graves
    

    

      
      #
    

  


  

      
Hello, Edward Wei:


	  Are you familiar with R Packages (2nd edition) Hadley Wickham and 
Jenny Bryan?


https://r-pkgs.org


	  This book is the most up-to-date information I know on preparing 
something for CRAN.  To your question specifically, I have a "WORDLIST" 
file in an "inst" folder.


	  Below please find notes I've prepared for myself on the various tests 
I've gotten from their book, etc.  The section numbers refer to an 
earlier version of this book.  Ignore or use with caution.


	  Hope this helps.
	  Spencer Graves


# File > "Open Project..." > [parent of Package file]

# https://r-pkgs.org/release.html

#20.1.  Pick a version number:
#       in DESCRIPTION: must be later than any version on CRAN
#20.3.  The submission process
#       Store submission comments in cran-comments.md
#20.3.1.  Test environments
# devtools::check_win_*()
dir()

PkgName <- "Ecdat"
PkgRegExpr <- paste0('^', PkgName, '$')
(Pkg <- dir(pattern=PkgRegExpr))

devtools::check_win_devel(Pkg)
devtools::check_win_release(Pkg)
devtools::check_win_oldrelease(Pkg)

# devtools::check_rhub(Pkg)
#Error in match_platform(platform) :
#   Unknown R-hub platform, see rhub::platforms() for a list
# on 2022-07-04.

# https://r-pkgs.org/release.html
# now recommends:

rhub::check(Pkg)

# Select
# 3.  Apple Silicon (M1), macOS 11.6 Big Sur, R-release 
(macos-m1-bigsur-release)
# This may not be correct:  I have mac)S 11.6.7 running an Intel core i7.


#20.3.3.  Reverse dependencies

# install.packages("revdepcheck")
#devtools::install_github('r-lib/revdepcheck')

# revdepcheck::revdep_reset(Pkg)

# revdepcheck::revdep_check(Pkg, num_workers = 4)

#20.4.  Update README.md and NEWS.md

#20.5.  Submit to CRAN

library(devtools)
# spell_check(Pkg)

release(Pkg)

#20.6.  Update the version number for the future
#20.7.  Publicise

#20.1.  Pick a version number:  in DESCRIPTION > what's on CRAN

#20.2.  Run & document R CMD check
# 2.1-0 because this is to match the move of
# the database maintenance to wu.ut.at

#20.3.  Check CRAN policies
#20.4.  Update README.md and NEWS.md
#20.5.  Submit to CRAN
#20.6.  Update the version number for the future
#20.7.  Publicise

        
On 8/9/22 3:38 PM, Edward Wei wrote:

            

      
      
      
    

        

      
      
    

  
  


  


      

    

    

      
      

        


  

        

      Uwe Ligges
    

    

      
      #
    

  


  

      
On 09.08.2022 22:38, Edward Wei wrote:

            

      
      
      
    

        
Software names should be single quotes in the Title and Description 
fields of the DESCRIPTION file. Other "possibly misspelled" words that 
are actually fine will be reviewed by manual inspection anyway. Just 
ignore these.

            

      
      
      
    

        
No. You should submit a package created by R CMD build which will not 
generated tar.gz files within in your package structure.

Best,
Uwe Ligges

            

      
      
      
    

        

      
      
    

  
  


  


      

    

    

      
      

        


  

        

      Serguei Sokol
    

    

      
      #
    

  


  

      
Le 09/08/2022 ? 22:38, Edward Wei a ?crit?:

            

      
      
      
    

        
You can try to surround package names in singe quotes <'>.

            

      
      
      
    

        
Right. However, you can want to distribute some auxiliary data, e.g. 
data supporting examples in your doc. In this case, such auxiliary files 
can go in "inst/" directory. All the content from this directory will be 
placed in the root of your package. So it may be more informative for an 
end-user to place them in "inst/examples/" or alike. Thus, the user will 
find them in "<package_dir>/examples/".

Best,
Serguei.