search

ARS-toscana / GenerateMatchedDataset

Function to generate a dataset of matched sets
GNU Affero General Public License v3.0
0 stars 0 forks source link

No man pages found in package ‘matchboots’ #3

Open LindaNab opened 1 month ago

LindaNab commented 1 month ago

Just to flag there are no man pages found in the package, of which the user will get notified when installing the package. Think you should be able to configure these using roxygen2 given that you've written some documentation for function GenerateMatchedDataset. Probably devtools::document() should do the trick. See https://github.com/LindaNab/seqtrial for an example of expected structure of an package.

LindaNab commented 1 month ago

Would be great to be able to do ?GenerateMatchedDataset in R after having installed the package and see expected parameters + some examples 👍 .

DavideMessinaARS commented 1 month ago

I've created a new version with simple documentation of the function. In the future, it will be improved to include a more detailed explanation and some examples.