Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Simkovic committed Jan 4, 2017
1 parent cb5f81d commit bd1ad02
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ Key Features
- Easy-to-use wrappers for the most-commonly used software, e.g. HHblits, Jackhmmer, CCMpred, PSICOV, ...
- Many convenience functions for prediction-structure matching, determination of True Positive contacts, calculation of MSA and contact prediction statistics, etc.

News
~~~~

ConKit was presented at the CCP4 Study Weekend 2017. To view the presentation slides, `click here <https://fsimkovic.github.io/Presentations/ccp4_sw2017.html#/>`_.

Contributing
~~~~~~~~~~~~
There are two ways by which you can contribute to ConKit:
Expand Down
5 changes: 2 additions & 3 deletions docs/examples/pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,8 @@ Our final contact prediction matrix is now stored in the file with the name ``co

.. code-block:: python
>>> f_in = open(matrix_fname, 'r')
>>> f_out = open(casprr_fname, 'w')
>>> io.convert(f_in, 'ccmpred', f_out, 'casprr')
>>> with open(matrix_fname, 'r') as f_in, open(casprr_fname, 'w') as f_out:
... io.convert(f_in, 'ccmpred', f_out, 'casprr')
This will produce your final contact prediction in Casp RR format in the file ``conkit_example.rr``

Expand Down
1 change: 1 addition & 0 deletions docs/scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The following scripts are currently shipped with ConKit:

- :obj:`conkit.convert` - script to convert file formats
- :obj:`conkit.msatool` - script to analyse a Multiple Sequence Alignment
- :obj:`conkit.plot_map` - script to plot a contact map
- :obj:`conkit.precision` - script to calculate the contact prediction precision value
- :obj:`conkit.predict` - simple contact prediction pipeline using HHblits, HHfilter and CCMpred

Expand Down

0 comments on commit bd1ad02

Please sign in to comment.