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 use cases to the documentation #90

Closed
3 of 5 tasks
ismael-lajaaiti opened this issue Jan 16, 2023 · 4 comments · Fixed by #107 or #119
Closed
3 of 5 tasks

Add use cases to the documentation #90

ismael-lajaaiti opened this issue Jan 16, 2023 · 4 comments · Fixed by #107 or #119
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ismael-lajaaiti
Copy link
Collaborator

ismael-lajaaiti commented Jan 16, 2023

Use cases illustrating the following features should be added to the documentation:

  • non-trophic interactions (e.g. reproduction of Miele 2019) First use cases. #107
  • mortality term First use cases. #107
  • temperature dependence (@hanamayall you can simply put the use cases that you'll use for the manuscript)
  • explicit nutrient intake (@evadelmas)
  • interaction with the extension package EcologicalNetworkStability.jl (e.g. reproduction of Dominguez-Garcia 2019)
@ismael-lajaaiti ismael-lajaaiti added the documentation Improvements or additions to documentation label Jan 16, 2023
@ismael-lajaaiti ismael-lajaaiti linked a pull request Jan 16, 2023 that will close this issue
3 tasks
@iago-lito iago-lito linked a pull request Feb 14, 2023 that will close this issue
@iago-lito
Copy link
Collaborator

@ismael-lajaaiti Can we tick a few boxes here now that #107 has landed? What's still needing to be done? :)

@iago-lito iago-lito linked a pull request Mar 13, 2023 that will close this issue
@ismael-lajaaiti
Copy link
Collaborator Author

ismael-lajaaiti commented May 5, 2023

There is still two boxes to tick, nutrients use case and document EcologicalNetworksStability. We need to wait for the 1st one but the 2nd one is actually a bit out-of-scope of this issue, so we can forget about it for now.
Also to be clear, use cases are not yet incorporated in the documentation but are stored in a folder within package.
Anyway, I think that as soon as Eva submits her use case (that last one that we are waiting for) we can close this PR and open two new ones : one to incorporate this use case within the online documentation and another one to create documentation page about the companion package EcologicalNetworksStability. Does it seem good to you?

@iago-lito
Copy link
Collaborator

Sure. Regarding the integration within the doc, I think it's already covered by #118.

@iago-lito
Copy link
Collaborator

Closing in favour of #118.

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
Projects
None yet
4 participants