diff --git a/conekt/models/gene_families.py b/conekt/models/gene_families.py index 63c2081..2d278d7 100644 --- a/conekt/models/gene_families.py +++ b/conekt/models/gene_families.py @@ -294,11 +294,10 @@ def family_stats(self): @staticmethod def __add_families(families, family_members): """ - Adds gene families to the database and assigs genes to their designated family + Adds gene families to the database and assigns genes to their designated family - :param families: - :param family_members: - :return: + :param families: list of GeneFamily objects + :param family_members: dict (keys = gene family name) with lists of members """ for i, f in enumerate(families): db.session.add(f) diff --git a/docs/tutorials/001_basics.md b/docs/tutorials/001_basics.md index 214e56a..0b57da1 100644 --- a/docs/tutorials/001_basics.md +++ b/docs/tutorials/001_basics.md @@ -1,8 +1,20 @@ # Tutorial: The basics -## Home page and Menu +## Home page and Species page +![overview](images/overview.png "Conekt Overview") +On the CoNekT you quickly can get updated about announcements (e.g. server downtime), recent changes and general +updates from the lab's twitter feed. + +To check out which **species** are currently included in CoNekT, a species page can be accessed through the **menu button** +named **Species** on the top of the page. This will bring up a page with the species tree and a table with species included +along with some general statistics. + +![species](images/species.png "Species") + +Note the buttons to **download** all gene **sequences** and the complete co-expression **networks**. Click on a species +name to bring up a brief description and other relevant information (e.g. useful links, ... ) ## Search diff --git a/docs/tutorials/images/overview.png b/docs/tutorials/images/overview.png new file mode 100644 index 0000000..b182e1c Binary files /dev/null and b/docs/tutorials/images/overview.png differ diff --git a/docs/tutorials/images/species.png b/docs/tutorials/images/species.png new file mode 100644 index 0000000..0de638e Binary files /dev/null and b/docs/tutorials/images/species.png differ