Adding a section "similar work" to README

[sinarueeger]

I think it would be useful to have a section in the README file that compares biomartr to similar work, most importantly biomaRt.

It would help the user understand the differences between these two packages with almost identical names.

I came across a section like this in the drake package.

[HajkD]

Hi Sina,

Thank you very much for your great feedback and suggestion.

I am aware that the similar naming of the packages is unfortunate, but it arose due to historical reasons (please find a detailed explanation here: https://github.com/ropensci/biomartr/blob/master/FAQs.md and here #11).

I also dedicated an entire vignette to compare the biomaRt and biomartr package functionality in the context of Functional Annotation (where their functionality overlaps which comprises about only 20% of the overall functionality of the biomartr package).

If it would help then I am happy to also add a section named similar work to the README to
point to the above-mentioned resources more obviously.

Many thanks and best wishes,
Hajk

[sinarueeger]

Hi Hajk

I did know that there was a FAQ file, should have checked. Those are some good explanations, thank you!

You could have a very short README section dedicated to similar work where you refer to issue #11 and the FAQs.

Best wishes
Sina

[HajkD]

Hi Sina,

Perfect. I now added the new section to the README so that future users will have a better chance to learn the differences between the packages.

Once more thank you very much for your suggestion and I always welcome feedback :))))

Cheers,
Hajk

[sinarueeger]

Great - thanks for adding this!