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

Vignette: Strategies to optimize performance/memory usage #274

Closed
trangdata opened this issue Sep 10, 2024 · 4 comments
Closed

Vignette: Strategies to optimize performance/memory usage #274

trangdata opened this issue Sep 10, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request vignette

Comments

@trangdata
Copy link
Collaborator

Perhaps we could put together a vignette on different strategies to optimize openalexR's performance and to consolidate the many GH issue threads we have had:

  • select = ...
  • output = "list"
  • oa_generate with save as .rds in chunks for (memory)
  • ... (anything else? @yjunechoe)
  • link to different issues, explain our thinking re breaking changes, backward compatibility, etc. (maybe this is a different vignette?)
@trangdata trangdata self-assigned this Sep 10, 2024
@trangdata trangdata added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 10, 2024
@yjunechoe
Copy link
Collaborator

Maybe the last bullet point can be a different vignette (broadly covering "Reproducibility", perhaps?) but I agree!

If you want to divide the work I can write up the strategy I wrote about the other day - #271 (comment). I'm less familiar with the oa_generate() strategy though.

@rkrug
Copy link

rkrug commented Sep 10, 2024

I think this is a great idea, but I would advise against oa_generate(). I tried to use it, it took me a considerable time to implement it, and then I had a bug somewhere which I did not figure out how to use.

Adding "each page as json in a directory" would make the use of oa_generate() not necessary and, imho, easier to maintain. The usage of the data in that directory would be completely to the advanced user. But I really like this idea of a vignette on this topic.

@trangdata
Copy link
Collaborator Author

If you want to divide the work I can write up the strategy I wrote about the other day - #271 (comment)

That would be great! Do you want to start the vignette? and I will add the oa_generate part after? Thanks so much June!

@trangdata
Copy link
Collaborator Author

Completed in #277

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request vignette
Projects
None yet
Development

No branches or pull requests

3 participants