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

Port R code from acteng/netgen here #67

Closed
robinlovelace-ate opened this issue Sep 3, 2024 · 7 comments
Closed

Port R code from acteng/netgen here #67

robinlovelace-ate opened this issue Sep 3, 2024 · 7 comments

Comments

@robinlovelace-ate
Copy link

There's some functions and docs here that I'm sure will be useful to people wanting to run this with R data science background: https://github.com/acteng/netgen

Discussed with @dabreegster already, we're looking for 'loose coupling', with the functions focussing on prepping the data rather than actually calling the tool via CLI.

Assuming we go with it there are some questions: where should the package live (in an r/ directory like odjitter being default I think)? And how can we render the auto-generated R docs (see links here): https://acteng.github.io/netgen/ ?

@robinlovelace-ate
Copy link
Author

cc @Robinlovelace for non ATE days.

@dabreegster
Copy link
Collaborator

where should the package live (in an r/ directory like odjitter being default I think)? And how can we render the auto-generated R docs

A subdirectory like that is fine, yes. We can auto-generate and serve the R docs alongside the hosted web app by following https://github.com/acteng/netgen/blob/main/.github/workflows/pkgdown.yaml, but putting things in a subdirectory. When the R directory is started here, I can set this up

@Robinlovelace
Copy link
Collaborator

Just tried to create a branch linked to this issue but don't have permissions:

gh issue develop 67 --checkout
GraphQL: Robinlovelace does not have the correct permissions to execute `CreateLinkedBranch` (createLinkedBranch)

Robinlovelace added a commit to Robinlovelace/od2net that referenced this issue Sep 4, 2024
@robinlovelace-ate
Copy link
Author

PR ready for review.

dabreegster pushed a commit that referenced this issue Sep 10, 2024
* Add minimal R package (#67)

* Add URL

* Port make_zones() to README, style file

* More tweaks to pkg

* Document functions

* Reformat

* Re-document

* Changes for all R pkg checks to pass

* Document, ready for review

* Add demo config
@Robinlovelace
Copy link
Collaborator

This is done now (cannot close from this account).

@dabreegster
Copy link
Collaborator

I'll set up the R docs on GH pages then close

@dabreegster
Copy link
Collaborator

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

3 participants