Skip to content

Commit

Permalink
better formation of functions documentary
Browse files Browse the repository at this point in the history
  • Loading branch information
hng committed Mar 30, 2015
1 parent 77bb76b commit 2ad30bf
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/modeller.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ You need to [install](https://salilab.org/modeller/download_installation.html) M

## Exported functions

### Generator function

```julia
gen_modeller_script(name::String)
```
Expand All @@ -27,9 +29,12 @@ Scripts are generated in the current working directory. You can find all scripts
```julia
gen_modeller_script("build_profile")
```
### Functions for MODELLER integration with Julia

This module also provides a few simple functions that provide common MODELLER tasks. These are again adapted from the MODELLER basic example. The given examples calls should work inside the modeller-basic-example directory. These functions can be used as building blocks or starting points for more sophisticated workflows.

#### build_profile

```julia
build_profile(;seq_database_file::String = "", seq_database_format::String="PIR", sequence_file::String = "",
sequence_format::String = "PIR", output_name::String = "build_profile", output_profile_format::String="TEXT", output_alignment_format::String="PIR")
Expand All @@ -39,13 +44,17 @@ Searches a given sequence database for a given sequence (file) and writes hits t

Note: this function is using keyword arguments.

#### compare

```julia
compare(pdbs)
```
Prints out a table with the similarities between the given structures and a dendrogram.

*pdbs:* Array of pairs of pdb-files and chains that should be compared.

#### align2d

```julia
align2d(model_file::String, model_segment, model_align_codes::String, atom_files::String, sequence_file::String, sequence_codes::String, outputname::String)
```
Expand All @@ -66,6 +75,8 @@ Aligns a structure model (pdb) with a sequence. Writes the alignment to <outputn

*outputname:* name of the files that ``align2d()`` creates.

#### model_single

```julia
model_single(alnf::String, known_structure::String, seq::String)
```
Expand All @@ -75,13 +86,17 @@ model_single(alnf::String, known_structure::String, seq::String)

*seq:* sequence

#### evaluate_model

```julia
evaluate_model(pdbfile::String, outputfile::String = "")
```
*pdbfile:* path to pdb file

*outputfile:* optional path to output file. Defaults to pdbfile+".profile"

#### plot_profiles

```julia
plot_profiles(alignment_file::String, template_profile::String, template_sequence::String, model_profile::String, model_sequence::String, plot_file::String = "dope_profile.png")
```
Expand Down

0 comments on commit 2ad30bf

Please sign in to comment.