How to contribute?

[seantma]

@cwatson
Appreciate your effort on this package and releasing it to others! Do you have any guidelines on how others can help contribute?

[cwatson]

Hi Sean, no I don't have anything detailed/structured for contributing. I can add it to my TODO list and think about it, but that will have to wait until I finish v2.0.0, which is very close to being released.

Contributions could work the same as they do for any other Github repo, I think. But I don't have any experience with it. What are you interested in contributing?

[seantma]

@cwatson I just think this is a very cool project with excellent documentation!

Many other open source brain graph packages are Python-based with little documentation (& tutorials). Prior to encountering your package, I was thinking about writing up my own graph explorer to better visualize global & node-wise graph metrics. But I'm glad I've got a hold of your package.

I will need to play around with your packages and see how I could further provide value to it. Should be after the 2.0 release and after you have given some thoughts on how others can contribute to it.

[cwatson]

Thanks, @seantma ! That is actually one of the reasons I have spent so much extra time on the documentation. While I am getting ready to release v2.0.0, I have been updating the User Guide quite a bit, as well. I will also be putting it up on Github Pages because the Dropbox link keeps dying.

[cinhelli]

Hey @cwatson! I recently used your rich-club function as a base to develop a new core-profiling method and something called the complementary rich-club. I also discussed my results with Zhou and Mondragon (who discovered the rich-club...) and my results are published. If you are interested in contributions, it'd be my pleasure to share the code. :)

[seantma]

@cinhelli Would you mind sharing your publication here? I'm interested in learning more about it and how it further compliments rich-club. Thanks!

[cinhelli]

@seantma I can share the link here http://www.sciencedirect.com/science/article/pii/S037843711730852X
because of the publisher's requirements. But I also sent you an email with the paper :)

[cwatson]

@cinhelli Your paper looks really interesting (I have university access)! After I finish the v2.0.0 release, I will read it in detail and I can think about the best way to include it in the package (with an appropriate documentation section in the User Guide).

Thanks for your interest in brainGraph, and for using the package in your work. Would you mind if I add your paper to the Publications using brainGraph section in the User Guide (depending on how much you used it)?

[cinhelli]

@cwatson I could help in this process maybe also by uploading the functions on my GitHub in a way that is self-contained so that you can use them directly. Then I can help in providing a good doc and explanation. You can add my paper to the list. I used the rich-club function and the rewiring functions. Btw I think that your package is the only one implementing the rich-club coefficient in R so it should be helpful also for more general purposes. :)

[cwatson]

@cinhelli Thanks! I will let you know when v2.0.0 is released and check out your functions.

[cinhelli]

@cwatson I uploaded a function which contains (and returns as a output) all the measures used in my paper. It's on my page for whenever you'll have time :)
You'll notice that it's based on your rich-club function...

[seantma]

@cwatson Is there a common practice for R packages, such as brainGraph, to allow user written functions to be tested prior submitting it as a pull request to the main repository?

I have some ideas I would like to implement but I find it hard to access the brainGraph namespace if I call the package directly from library().

[cwatson]

Hi @seantma , I'm afraid I don't fully understand what you mean. If you've forked the repo, and added a function of your own then you should be able to re-build the package with the addition of your function, and then run your tests. Is this what you were asking about?

RE the namespace: could you describe the namespace access issue you mention?