maelstrom-research / Rmonize

3 stars 0 forks source link

List of Rmonize functions #24

Closed twey2 closed 7 months ago

twey2 commented 8 months ago

There are now many more functions indexed in the R help files than there were before and than there are documented on the online reference list at [https://maelstrom-research.github.io/Rmonize-documentation/reference/index.html]. I think a) the list of what to include needs to be reviewed, and b) the list of functions in different places need to match.

image

GuiFabre commented 8 months ago

You are right, we have a choice to make, but, i was testing the functions imported by madshapR in Rmonize. The online website has not been affected by the test, only us internally

when imported, EITHER the function is imported only as a function, but the documentation associated is not imported. the user cannot search for the documentation from Rmonize such function image

OR the function is imported, along with its documentation. The user can search for documentation which links to the original documentation (from madshapR) (the rdname object creates the link to the doc).

image

IF SO :

the documentation from help have all the functions in alphabetical order (not possible to do anything about that) and the documentation on the web site can be the same :

image

or this can be easily adapted (that what the test was for 😄) :

image

So... sky is the limit...

rwissa commented 8 months ago

20/10/2023 - decision de mettre deux sections dans rĂ©fĂ©rence. Pour finir, il faut passer Ă  travers liste pour dĂ©cider quelles fonctions doivent ĂȘtre importĂ©es automatiquement (TW, AT, et harmo)

GuiFabre commented 8 months ago

@a-trottier @twey2

la partie Reférences est mise à jour

https://maelstrom-research.github.io/Rmonize-documentation/reference/index.html

We can change the text or composition or add context. But keep in mind: the more we edit, the more we have to update.

image

a regarder

a-trottier commented 8 months ago

Pour moi ca va. Le "Objects exported from other packages" est pas un gros problÚme parce que cliqué sur les fonctions madshapR ouvre la documentation dans madshapR.