search

UCSF-DSCOLAB / cyclone

3 stars 2 forks source link

Make R package for sharing/managing documentation #1

Closed dtm2451 closed 2 years ago

dtm2451 commented 2 years ago

Creates an R package dscoSOM (name very much still up for debate -- I just started with that) and fills in the DESCRIPTION file with all required dependencies in the Imports: section. Theoretically, these packages would all be installed when a user attempts to install dscoSOM. In addition to a vignette, which I got started, we can create other documentation, which would be served to users via this package, for various pieces of the pipeline.

Regarding dependencies: There is one optional package (SCAFFoLD) which I left out from Imports:. As it's only needed for some use-cases, I think plugging the package in to a Suggests: section would make more sense than Imports:, but it's worth discussing... The way Suggests: works means it'd be on the user to install that package when needed. Thus we could discuss either adding it to Imports: anyway, or documenting how to install this package for users.

ravipatel4 commented 2 years ago

I like the idea of keeping SCAFFoLD in Suggests:.