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

Add documentation from R github packages? #9225

Open
rdstern opened this issue Oct 31, 2024 · 6 comments
Open

Add documentation from R github packages? #9225

rdstern opened this issue Oct 31, 2024 · 6 comments
Assignees
Milestone

Comments

@rdstern
Copy link
Collaborator

rdstern commented Oct 31, 2024

@lilyclements in #8858 you and @Vitalis95 extended the import packages to be able to import also github packages, and particularly (I hope soon) the R-Instat R packages.

We also have a dialog, in the Help menu, to examine the documentation of the CRAN R packages. Here it is:

image

Could we extend this dialog in a similar way? This time I suggest we don't need the add a button at the top. Could we just have your drop-down control with a list of the github packages? Perhaps have 2 radio buttons, with the first now saying Cran Package Name and a new one saying Github Package name.

Then we need a list of the R-Instat packages and the location of their documentation.

Once we have that list, I am also copying @rachelkg in this message, because we can also include the list and those links in the R-Instat help file.

@N-thony I am not sure this need be Vitalis. I suggest any of the team should be able to do this. I'll leave you to allocate, once we have a reacyion from @lilyclements with the list of our github packages.

@rdstern rdstern added this to the 0.7.23 milestone Oct 31, 2024
@lilyclements
Copy link
Contributor

@rdstern I think this all currently works already - provided the package is installed, it should all be in there and able to see the documentation and vignettes whether it is from GitHub or CRAN

image
image

Our R-Instat packages are:

  • instatExtras
  • databook
  • (and to be made: instatCalculations)

@rdstern
Copy link
Collaborator Author

rdstern commented Nov 1, 2024

@lilyclements that would be great, and I immediately retract the idea of adapting the Help > R-Packages Documentation dialog.

a) I tried to install the databook package. It said it could be installed. Could it be added to the drop-down list?
It installed fine. I then restarted R-Instat, and it then appeared (just as @lilyclements said!) in the packages. Great.

b) I tried to install the instatExtras package. Could it be added to the drop-down list? It said it could be installed, but then gave the error below.

image

c) And what of the existing packages in the github drop-down list? I assume they are related to e-PICSA?

@lilyclements
Copy link
Contributor

@rdstern I do know this error, and thought it was fixed. I know why it is occurring (because that climdex.pcic is no longer on CRAN). I'll sort this out soon, and get back to you on it. Thanks for this!

@lilyclements
Copy link
Contributor

@rdstern try instatExtras now. I'm hoping it will work for you! I've also now created instatClimatic, which are our "Extra" climatic functions

@rdstern
Copy link
Collaborator Author

rdstern commented Nov 4, 2024

@lilyclements that's great. Now instatExtras installs, and I'll check the documentation. Yes, that works too!
instatClimatic sounds perfect, but gives the same funny error, mentioning pcic, as above. Maybe that's not quite reasy yet?

@lilyclements
Copy link
Contributor

Good to know! I'll sort that one out, but at least instatExtras is working now

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

No branches or pull requests

3 participants