initial docs for tkonfound() added, but need to be expanded on

konfound-project / konfound

R package for carrying out sensitivity analysis

https://konfound-it.org/konfound/

Other

15 stars 9 forks source link

initial docs for tkonfound() added, but need to be expanded on #23

Closed jrosen48 closed 9 months ago

jrosen48 commented 4 years ago

these are added to R/tkonfound.R, but the documentation is just minimal/a placeholder for now.

jrosen48 commented 4 years ago

@linqinyu if you have the chance, could you add to these? I have use the royxygen2 conventions right before the function definition (see [R/konfound.R])(https://github.com/jrosen48/konfound/blob/master/R/konfound.R). When done, just run devtools::document(), and it should create the docs (magic of devtools!).

qinyun-lin commented 4 years ago

Sounds good! I will work on this now~:D

qinyun-lin commented 4 years ago

I have added more information to the tkonfound.R (and committed already). But I have some error running "devtools::document()". Maybe you can try it? (I don't want to mess things up.) Let me know if there are any problems!