search

mghotbi / DspikeIn

The importance of converting relative to absolute abundance in the context of microbial ecology: Introducing the user-friendly DspikeIn R package
https://herptilemicrobiomes.org/
9 stars 3 forks source link

README #7

Open hyphaltip opened 4 months ago

hyphaltip commented 4 months ago

Folks can provide feedback on README here

G-gnome commented 4 months ago

It would be nice to see a list of the most important functions and their goals, and a short example of usage.

mghotbi commented 4 months ago

Thanks!

On Wed, Jul 3, 2024 at 12:21 PM Kian Kelly @.***> wrote:

It would be nice to see a list of the most important functions and their goals, and a short example of usage.

— Reply to this email directly, view it on GitHub https://github.com/mghotbi/DspikeIn/issues/7#issuecomment-2206850882, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG56F42KA7IQBKLZQCQGGWTZKQXKLAVCNFSM6AAAAABKJ7CBROVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBWHA2TAOBYGI . You are receiving this because you are subscribed to this thread.Message ID: @.***>

G-gnome commented 4 months ago

Do we want to move some of the documentation into readthedocs? Seems like a simple way to show documentation and keep the README simple.

https://about.readthedocs.com/?ref=readthedocs.com

mghotbi commented 4 months ago

That's a wonderful idea 💡

On Wed, Jul 3, 2024, 16:00 Kian Kelly @.***> wrote:

Do we want to move some of the documentation into readthedocs? Seems like a simple way to show documentation and keep the README simple.

https://about.readthedocs.com/?ref=readthedocs.com

— Reply to this email directly, view it on GitHub https://github.com/mghotbi/DspikeIn/issues/7#issuecomment-2207283281, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG56F45X35F2K45CFSJZJSLZKRQ63AVCNFSM6AAAAABKJ7CBROVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBXGI4DGMRYGE . You are receiving this because you commented.Message ID: @.***>

G-gnome commented 4 months ago

I'll work on getting that started, and if we decide not to continue with it that's fine. Just exploring it as an option.

G-gnome commented 4 months ago

Looks like pkgdown is a better option for R packages actually so I will work on this:

https://pkgdown.r-lib.org/

mghotbi commented 4 months ago

yup I have an issue with readthedocs, let me check pkgdown

On Wed, Jul 3, 2024 at 4:30 PM Kian Kelly @.***> wrote:

Looks like pkgdown is a better option for R packages actually so I will work on this:

https://pkgdown.r-lib.org/

— Reply to this email directly, view it on GitHub https://github.com/mghotbi/DspikeIn/issues/7#issuecomment-2207343520, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG56F47ETQBG7UIQKPYQG6LZKRUORAVCNFSM6AAAAABKJ7CBROVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBXGM2DGNJSGA . You are receiving this because you commented.Message ID: @.***>

mghotbi commented 4 months ago

I just started decreasing dependencies

On Wed, Jul 3, 2024 at 4:41 PM Mitra Ghotbi @.***> wrote:

yup I have an issue with readthedocs, let me check pkgdown

On Wed, Jul 3, 2024 at 4:30 PM Kian Kelly @.***> wrote:

Looks like pkgdown is a better option for R packages actually so I will work on this:

https://pkgdown.r-lib.org/

— Reply to this email directly, view it on GitHub https://github.com/mghotbi/DspikeIn/issues/7#issuecomment-2207343520, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG56F47ETQBG7UIQKPYQG6LZKRUORAVCNFSM6AAAAABKJ7CBROVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBXGM2DGNJSGA . You are receiving this because you commented.Message ID: @.***>

G-gnome commented 4 months ago

I'm going to start a new issue for the pkgdown so we can keep this seperate from README

mghotbi commented 4 months ago

Great! Thank you!

On Wed, Jul 3, 2024 at 4:44 PM Kian Kelly @.***> wrote:

I'm going to start a new issue for the pkgdown so we can keep this seperate from README

— Reply to this email directly, view it on GitHub https://github.com/mghotbi/DspikeIn/issues/7#issuecomment-2207364886, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG56F45EMYXE7O2FLQZNS43ZKRWFJAVCNFSM6AAAAABKJ7CBROVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBXGM3DIOBYGY . You are receiving this because you commented.Message ID: @.***>