Changed main package documentation from .Rd file to .R file #87
Conversation
I didn't inlcude @Aliases phylosim-package @doctype package as it is stated in the DHARMA package, since this throws the warning "@doctpye is deprecated". I used @Keywords internal "_PACKAGE_" since that seems to be the new standard and unlike to tahminas post it doesnt seem to add a automated documention from the description. It seems to still rely on the information from the .R file Or maybe I'm understanding the idea behind using @Aliases phylosim-package @doctype package wrong. Do we need to have also an documentation when calling "?PhyloSim-package" ?
PhyloSim/NAMESPACE
Outdated
There was a problem hiding this comment.
.registration = TRUE hat gefehlt; habs gefixt und commited
There was a problem hiding this comment.
Ist überall gemacht. Hab außerdem, während ich jedes Script nochmal überprüft habe die examples gleich outsourced
|
I tested wheter @doctype is deprecated and if use @doctype i get the warning: ✖ PhyloSim-package.R:28: `@docType "package"` is deprecated. ℹ Please document "_PACKAGE" instead. I use roxygen version 7.3.0 I also tested whether it uses the information in DESCRIPTION or in the .R file by changing both @descrption arguments and starting the documentation and it did use the changes from the .R file
…e.g. code should be places in ``); Also outsourced help into the examples folder
|
OK, die Tests passen jetzt aber failen wegen der dependencies ... könnten wir im yaml mit Hand nachinstallierten aber da wir das eh als nächste lösen müssten würde ich das jetzt erst mal ignorieren, auch wenns schade ist dass es nicht automatisch geht. Hast du mal mit Hand getestet? |
|
Ich teste gerade und merge dann! |
…ttps://github.com/TheoreticalEcology/phylosim into Change-PhyloSim-package.RD-to-R-file-with-Roxygen
|
OK, das funktioniert auch nicht aber ich merge jetzt einfach erst mal, müssen wir dann fixen |
florianhartig
deleted the
Change-PhyloSim-package.RD-to-R-file-with-Roxygen
branch
I didn't inlcude
@Aliases phylosim-package
@doctype package
as it is stated in the DHARMA package, since this throws the warning "@doctpye is deprecated". I used
@Keywords internal
"PACKAGE"
since that seems to be the new standard and unlike to tahminas post it doesnt seem to add a automated documention from the description. It seems to still rely on the information from the .R file Or maybe I'm understanding the idea behind using
@Aliases phylosim-package
@doctype package
wrong.
Do we need to have also an documentation when calling "?PhyloSim-package" ?