Skip to content

Commit

Permalink
Add examples of outputs files
Browse files Browse the repository at this point in the history
  • Loading branch information
dzoanka committed Jan 30, 2024
1 parent f1b489d commit c4c62c1
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions docs/outputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,41 @@ Output files and directories

- ``baitlist.tsv``
This file contains information about the bait proteins used in the affinity purification-mass spectrometry (AP-MS) process.
(from input, not always generated)

- ``edgelist.tsv``
An edge list representation of the protein-protein interactions. Each row in this file represents an interaction between two proteins.
(from input, not always generated)

- ``ppi_edgelist.tsv``
A processed edge list file which represents protein-protein interactions, where proteins are identified by their symbols.

.. code-block::
geneA geneB
DNMT3A SAP18
DNMT3A DDX3X
DNMT3A SEC16A
DNMT3A U2SURP
DNMT3A SYNJ2
- ``ppi_gene_node_attributes.tsv``
Contains attributes for each gene node in the protein-protein interaction network. This includes information like gene names, ensembl ID, and other relevant data.

- ``ppi_gene_node_attributes.errors``
If there are any errors encountered while processing the gene node attributes, they will be logged in this file.
.. code-block::
name represents ambiguous bait
DNMT3A ensembl:ENSG00000119772 TRUE
HDAC2 ensembl:ENSG00000196591 TRUE
KDM6A ensembl:ENSG00000147050 TRUE
SMARCA4 ensembl:ENSG00000127616 TRUE
Logs and Metadata
-----------------

- ``ppi_gene_node_attributes.errors``
If there are any errors encountered while processing the gene node attributes, they will be logged in this file.

- ``output.log``
Log file detailing the operational logs of the script. Useful for understanding the flow of operations and debugging any issues.

Expand Down

0 comments on commit c4c62c1

Please sign in to comment.