Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing getPackageInfo in 0.2.0 #123

Closed
pelacables opened this issue Apr 27, 2021 · 7 comments
Closed

missing getPackageInfo in 0.2.0 #123

pelacables opened this issue Apr 27, 2021 · 7 comments

Comments

@pelacables
Copy link

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
Copy link
Owner

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
Copy link
Author

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

Thanks, I close this ticket.

@eddelbuettel
Copy link
Owner

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
Copy link
Author

Sure, all good from my side. Thanks.

@eddelbuettel
Copy link
Owner

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
Copy link
Owner

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
Copy link
Author

pelacables commented Apr 29, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants