Skip to content

Improving documentation #43

Description

@PeetoomHeida

I am trying to read through the documentation to understand how to use this package. I am impressed with the overall coverage of possible analyses that someone might want to run, however I think that the package is designed in a fairly opinionated manner/with a specific paradigm in mind, this is not a problem per se, but without more explicit documentation to hold the hands of new users, I think it is a very steep learning curve. I am coming from R's vegan, and am having a hard time figuring out what some of the options available are for, or how they relate to real world datasets. I am happy to help try to flesh out some of the documentation. I think the first part would be to give better examples of different Metacommunity constructions and to show how partitions can affect the output from various diversity functions. Additionally, I think adding a more explicit description of how to conceptualize "order" in the package and in general would go a long way towards improving the user experience for new users or those coming from vegan.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions