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

R tutorial in the documentation is not updated. #343

Open
keithwind opened this issue Feb 12, 2025 · 4 comments
Open

R tutorial in the documentation is not updated. #343

keithwind opened this issue Feb 12, 2025 · 4 comments

Comments

@keithwind
Copy link

On the R tutorial website, the function name used everywhere is GenCube, whereas the actual function name in the R library is gen_cube. Is this intentional? If not can I open a PR to fix it?

Image

Trying GenCube vs gen_cube in the R terminal.
Image

@keithwind
Copy link
Author

There are multiple other errors in other functions. Is the documentation not updated? I am willing to open a PR to fix all the issues with the tutorial examples.

@keithwind keithwind changed the title Typo in the name of R function GenCube R tutorial in the documentation is not updated. Feb 12, 2025
@vfisikop
Copy link
Contributor

Indeed the tutorial in the documentation refers to an old version of the CRAN package. You are more than welcome to fix/update it to refer to the current version on CRAN i.e. 1.1.2. It will also be useful to add a reference in tutorial to which version of CRAN it refers.

NOTE: You can use this tutorial but be careful as it refers to the current development branch of Rvolestihttps://github.com/GeomScale/Rvolesti) which is 1.2.0 so there are some differences (e.g. some now functions not appear in 1.1.2).

@keithwind
Copy link
Author

library(volesti)
P <- fileToMatrix('data/birk10.ine')

Here we are using the function fileToMatrix which is not present in the current version of volesti. The tutorial you shared uses the function gen_birkhoff which is also not available in the current version. The function gen_birkhoff is small enough that the code for it can be directly added in the documentation. Should I do that or is there any other way to fix this?

@vissarion
Copy link
Member

Indeed, fileToMatrix does not appear in the current CRAN version and the gen_birkhoff only appears in the development version. Ways to fix:

  1. add the implementation of gen_birkhoff in tutorial
  2. remove Birkhoff example
  3. create birhoff polytope using Hpolytope class
  4. upgrade the tutorial to use the development version and use gen_birkhoff

I propose to go for 4 and the whole tutorial will refer to development version 1.2.0 which will eventually replace the current CRAN version.

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