Skip to content

Commit

Permalink
minor
Browse files Browse the repository at this point in the history
  • Loading branch information
hng committed Mar 27, 2015
1 parent 10e49d3 commit b563563
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions docs/modeller.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,31 @@

## Exported functions

``
gen_script(name::String)``
```julia
gen_script(name::String)
```

Generates Julia scripts for MODELLER.
name: The name of the script (minus the extension), e.g. "build_profile"
These scripts are based on the basic example scripts from the MODELLER website.
Scripts are generated in the current working directory. You can find all scripts that can be generated in src/MODELLER/modeller-basic-example-julia .

``
```julia
build_profile(;seq_database_file::String = "", seq_database_format::String="PIR", alignment_file::String = "", alignment_format::String = "PIR", output_name::String = "build_profile", output_profile_format::String="TEXT", output_alignment_format::String="PIR")
``
```

**Example:**

`` build_profile(seq_database_file="pdb_95.pir", alignment_file="TvLDH.ali") ``
```julia
build_profile(seq_database_file="pdb_95.pir", alignment_file="TvLDH.ali")
```

`` align2d(model_file::String, model_segment, model_align_codes::String, atom_files::String, align_file::String, align_codes::String, outputname::String)``
```julia
align2d(model_file::String, model_segment, model_align_codes::String, atom_files::String, align_file::String, align_codes::String, outputname::String)
```

**Example:**

``align2d("1bdm.pdb", ("FIRST:A","LAST:A"), "1bdmA", "1bdm.pdb", "TvLDH.ali", "TvLDH", "TvLDH-1bdmA")``
```julia
align2d("1bdm.pdb", ("FIRST:A","LAST:A"), "1bdmA", "1bdm.pdb", "TvLDH.ali", "TvLDH", "TvLDH-1bdmA")
```

0 comments on commit b563563

Please sign in to comment.