Skip to content

Commit

Permalink
fix bulletpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
aewebb80 committed Aug 28, 2020
1 parent c2961b2 commit 0b1036a
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/source/PPP_pages/develop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Development Guidelines

**In general:**

* Functions developed for the PPP should be modular – i.e. function independently – primarily to maintain a flexible platform, this is especially important when considering `Galaxy <https://galaxyproject.org/>`_. integration.
* Functions developed for the PPP should be modular – i.e. function independently – primarily to maintain a flexible platform, this is especially important when considering `Galaxy <https://galaxyproject.org/>`_ integration.
* Functions should be able to be imported from **pgpipe**, so that multiple functions may be used within a single python script or `Jupyter notebook <https://jupyter.org/>`_.
* Functions should support the use of Model files for automatic assignment of relevant meta-data. *Note: details on the model file class may be found below*
* Functions that use third-party software should include the relevant reference(s) within log files.
Expand Down Expand Up @@ -51,8 +51,8 @@ A **ModelFile** class object primarily behaves as a dictionary of **Model** clas
A **ModelFile** class object also has two additional attributes:

*ind_file: If created, the filename of a file containing all the unique individuals found within all models stored within the **ModelFile**.
*exclude_file: If created, the filename of a file containing all the unique individuals found within all models stored within the **ModelFile** that do not match a given list of individuals.
* ind_file: If created, the filename of a file containing all the unique individuals found within all models stored within the **ModelFile**.
* exclude_file: If created, the filename of a file containing all the unique individuals found within all models stored within the **ModelFile** that do not match a given list of individuals.

These attributes may be populated and their files created using the following functions: **create_ind_file()** and **create_exclude_ind_file()**. The inverse operating can also be completed using **delete_ind_file()** and **delete_exclude_ind_file()**.

Expand All @@ -61,13 +61,13 @@ Model Class
***********
The **Model** class is used to store model meta-data. The primary attributes of the class are:

*name: The name (as a string) of the model
*tree: The newick tree of the model
*pop_list: A list of the population names within the model
*ind_dict: A dictionary used to store the individuals within each population; the keys of the dictionary are the population names whereas the values are lists of individuals.
*nind: A dictionary used to store the number of individuals within each population; the keys of the dictionary are the population names whereas the values are individual counts.
*npop: The number of populations within the model
*inds: A list of all individuals in the model
* name: The name (as a string) of the model
* tree: The newick tree of the model
* pop_list: A list of the population names within the model
* ind_dict: A dictionary used to store the individuals within each population; the keys of the dictionary are the population names whereas the values are lists of individuals.
* nind: A dictionary used to store the number of individuals within each population; the keys of the dictionary are the population names whereas the values are individual counts.
* npop: The number of populations within the model
* inds: A list of all individuals in the model


A Model may be created with all primary attributes populated as shown below:
Expand All @@ -86,8 +86,8 @@ A Model may be created with all primary attributes populated as shown below:
A **Model** class object also has two additional attributes:

*pop_files: If created, a list of population filenames. Each population file consist of the individuals found within the population.
*ind_file: If created, the filename of a file containing all the unique individuals found within the model.
* pop_files: If created, a list of population filenames. Each population file consist of the individuals found within the population.
* ind_file: If created, the filename of a file containing all the unique individuals found within the model.

These attributes may be populated and their files created using the following functions: **create_ind_file()** and **create_pop_files()**. The inverse operating can also be completed using **delete_ind_file()** and **delete_pop_files()**.

Expand Down

0 comments on commit 0b1036a

Please sign in to comment.