eddelbuettel / drat

Drat R Archive Template
https://eddelbuettel.github.io/drat
152 stars 101 forks source link

missing getPackageInfo in 0.2.0 #123

Closed pelacables closed 3 years ago

pelacables commented 3 years ago

I've installed drat from CRAN but I cannot find the getPackageInfo function:

other attached packages:
[1] drat_0.2.0
[...]
> library('drat')
> getPackageInfo('/home/bria/BestPackageEver_0.1.0.tar.gz')
Error in getPackageInfo("/home/bria/BestPackageEver_0.1.0.tar.gz") :
  could not find function "getPackageInfo"
> drat::
drat::updateRepo                      drat::pruneRepoForAllRversions        drat::insertPackages
drat::initRepo                        drat::pruneRepo                       drat::addRepo
drat::insertPackage                   drat::getRepoInfo
drat::archivePackagesForAllRversions  drat::archivePackages
> drat::

am I missing anything? Thanks

eddelbuettel commented 3 years ago

It's still there:

> drat:::getPackageInfo("drat_0.2.0.tar.gz")
   Source    Rmajor osxFolder 
   "TRUE"        NA        "" 
> 

Note the use of :::. As an internal function, it is not currently exported -- but I don't think it ever was.

Are you seeing it referenced in a tutorial or vignette or some other write up?

pelacables commented 3 years ago

I see. I was reading this: https://cran.r-project.org/web/packages/drat/drat.pdf .

Thanks, I close this ticket.

eddelbuettel commented 3 years ago

Right. The reference pdf is a list of all help pages. I guess I should go over them and mark the exported functions as private. Or make them private.

But we have six other vignettes :) maybe those can help with documentation too?

pelacables commented 3 years ago

Sure, all good from my side. Thanks.

eddelbuettel commented 3 years ago

I am looking at this now, and I could either make the function publically available (yet, on balance, smaller exported footprint is better), or remove the documentation (seems like a loss) or just mark it as an-unexported function in the documentation. I think I am leaning towards the latter...

eddelbuettel commented 3 years ago

Now done -- thanks again for the heads-up.

The documentation should be clearer now. (The pdf file will only be rebuilt on the next package release though.)

pelacables commented 3 years ago

Thanks a lot.

On Thu, 29 Apr 2021 at 15:10, Dirk Eddelbuettel @.***> wrote:

Now done -- thanks again for the heads-up.

The documentation should be clearer now. (The pdf file will only be rebuilt on the next package release though.)

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/eddelbuettel/drat/issues/123#issuecomment-829224183, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAYX2LTG2UK2GNOZTCZZG5LTLFLDDANCNFSM43UTN5UA .

-- Arnau Bria