[R-pkg-devel] Starter Help

2019-02-17 Thread ivo welch
Apologies for the Intrusion.  I am trying to learn package development with
roxygen.  The ecosystem has been moving so fast that much of what I learned
by googling and reading on the web (including old posts) seems to be at
least mildly outdated.

* does the r-package-devel mailing list have a search engine?  (or generic
google?)  a FAQ?

* could someone please point me to a good current example that follows
appropriate style and other guidelines, using the '@' roxygen documentation
format?  (The '@' example In Hadley's book does not include a @name, which
my `document()`  does not like.)

I also have a few specific questions, but I may be able to figure it out
given the above.

* is it possible to import a set of *.Rd man documentation files into my R
session?

* is it still good practice to place my functions into their own
environments (aka `me$myfun <- cmpfun(function() message("my fun")`).  I am
thinking that this complicates matters unnecessarily in a package, given
that packages have namespaces, and environment prefixes makes documentation
access more complex (not ?me$myfun but ?'me$myfun' now).  and should I lose
the `cmpfun` in a package?

basic pointers appreciated.

/iaw

[[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] registering native routines

2019-02-17 Thread Charles Geyer
Sorry.  I am a moron.  It was an illusion.  I was checking R package
foo with the Makevars for R package fooRegister via the
R_MAKEVARS_USER mechanism and got confused.  In fact R package foo,
when checked with --as-cran only gives warnings not errors about
registering native routines.

So AFAICS, CRAN warns against not using registration of native
routines but that is not yet an ERROR.  So that is what I am going to
tell the students.

All of my CRAN packages properly register native routines, and I teach
this to my advisees and students.  But my github packages I use as
teaching examples don't (except for the aforementioned fooRegister)
and I was suddenly worried about them.


On Sat, Feb 16, 2019 at 9:41 PM Avraham Adler  wrote:
>
> https://stat.ethz.ch/pipermail/r-devel/2017-February/073755.html
>
> On Sat, Feb 16, 2019 at 3:22 PM Charles Geyer  wrote:
> >
> > I just noticed that R package foo in the github repo
> > https://github.com/cjgeyer/foo no longer passes R CMD check --as-cran.  The
> > problem seems to be that it does not register native routines and thus the
> > C routines cannot be found.  It does pass R CMD check (without --as-cran).
> > The version of the package that does register native routines (package
> > fooRegister) in the same repo passes with or without --as-cran.  So did I
> > miss the announcement?  Is registration of native routines now mandatory
> > for CRAN?
> >
> > Just asking because I am currently teaching about R packages in PhD level
> > statistical confusing and don't want to provide erroneous info.
> >
> > These packages are toy packages to introduce the class to R packages.  I
> > don't actually want to put them on CRAN.
> >
> > --
> > Charles Geyer
> > Professor, School of Statistics
> > Resident Fellow, Minnesota Center for Philosophy of Science
> > University of Minnesota
> > char...@stat.umn.edu
> >
> > [[alternative HTML version deleted]]
> >
> > __
> > R-package-devel@r-project.org mailing list
> > https://stat.ethz.ch/mailman/listinfo/r-package-devel



-- 
Charles Geyer
Professor, School of Statistics
Resident Fellow, Minnesota Center for Philosophy of Science
University of Minnesota
char...@stat.umn.edu

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