Skip to content

Commit 4bd8b8d

Browse files
committed
Fix FoldMason description in main foldmason entrypoint #33
1 parent dd3c235 commit 4bd8b8d

File tree

1 file changed

+5
-28
lines changed

1 file changed

+5
-28
lines changed

src/foldmason.cpp

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
const char* binary_name = "foldmason";
88
const char* tool_name = "foldmason";
9-
const char* tool_introduction = "<< TODO >> .\n\nPlease cite:\n << TODO >>";
10-
const char* main_author = "Cameron L.M. Gilchrist, Milot Mirdita, Johannes Söding, Martin Steinegger";
9+
const char* tool_introduction = "FoldMason is a progressive aligner for fast and accurate multiple alignment of hundreds of thousands of protein structures.\n\nPlease cite:\n Gilchrist CLM, Mirdita M, Steinegger S. Multiple Protein Structure Alignment at Scale with FoldMason. bioRxiv, 2024.06.20.44908 (2024).\n";
10+
const char* main_author = "Cameron L.M. Gilchrist, Milot Mirdita, Martin Steinegger";
1111
const char* show_extended_help = "1";
1212
const char* show_bash_info = NULL;
1313
const char* index_version_compatible = "fs1";
@@ -28,21 +28,21 @@ std::vector<struct Command> foldmasonCommands = {
2828
{"easy-msa", easymsa, &foldmasonPar.easymsaworkflow, COMMAND_EASY,
2929
"Sensitive homology search and build MSAs",
3030
"# Align a set of PDB files and create a MSA\n"
31-
"foldseek easy-msa example/d1asha_ result.m8 tmp\n",
31+
"foldmason easy-msa example/d1asha_ result.m8 tmp\n",
3232
"Cameron Gilchrist <gamcil@snu.ac.kr> & Martin Steinegger <martin.steinegger@snu.ac.kr>",
3333
"<i:PDB|mmCIF[.gz]> ... <i:PDB|mmCIF[.gz]>|<i:stdin> <o:alignmentFile> <tmpDir>",
3434
CITATION_FOLDMASON, {{"PDB|mmCIF[.gz]|stdin", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA | DbType::VARIADIC, &DbValidator::flatfileStdinAndGeneric },
3535
{"alignmentFile", DbType::ACCESS_MODE_OUTPUT, DbType::NEED_DATA, &DbValidator::flatfile },
3636
{"tmpDir", DbType::ACCESS_MODE_OUTPUT, DbType::NEED_DATA, &DbValidator::directory }}},
3737
{"structuremsa", structuremsa, &foldmasonPar.structuremsa, COMMAND_ALIGNMENT,
38-
"Compute guide tree based on Foldseek scores",
38+
"Multiple structure alignment from a set of protein structures in DB format",
3939
NULL,
4040
"Cameron Gilchrist <gamcil@snu.ac.kr> & Martin Steinegger <martin.steinegger@snu.ac.kr>",
4141
"<i:queryDB> <o:alignmentFile>",
4242
CITATION_FOLDMASON, {{"queryDB", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA, &DbValidator::sequenceDb },
4343
{"alignmentFile", DbType::ACCESS_MODE_OUTPUT, DbType::NEED_DATA, &DbValidator::flatfile }}},
4444
{"structuremsacluster", structuremsacluster, &foldmasonPar.structuremsa, COMMAND_ALIGNMENT,
45-
"Compute guide tree based on Foldseek scores",
45+
"MSTA based on an existing (pre-)clustering DB",
4646
NULL,
4747
"Cameron Gilchrist <gamcil@snu.ac.kr> & Martin Steinegger <martin.steinegger@snu.ac.kr>",
4848
"<i:queryDB> <i:clusterDB> <o:alignmentFile>",
@@ -80,29 +80,6 @@ std::vector<struct Command> foldmasonCommands = {
8080
CITATION_FOLDMASON, {{"queryDB", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA, &DbValidator::sequenceDb },
8181
{"msaFileIn", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA, &DbValidator::flatfileAndStdin },
8282
{"msaFileOut", DbType::ACCESS_MODE_OUTPUT, DbType::NEED_DATA, &DbValidator::flatfile },}},
83-
{"convertalis", structureconvertalis, &foldmasonPar.convertalignments, COMMAND_FORMAT_CONVERSION,
84-
"Convert alignment DB to BLAST-tab, SAM or custom format",
85-
"# Create output in BLAST M8 format (12 columns):\n"
86-
"# (1,2) identifiers for query and target sequences/profiles,\n"
87-
"# (3) sequence identity, (4) alignment length, (5) number of mismatches,\n"
88-
"# (6) number of gap openings, (7-8, 9-10) alignment start and end-position in query and in target,\n"
89-
"# (11) E-value, and (12) bit score\n"
90-
"foldseek convertalis queryDB targetDB result.m8\n\n"
91-
"# Create a TSV containing pairwise alignments\n"
92-
"foldseek convertalis queryDB targetDB result.tsv --format-output query,target,qaln,taln\n\n"
93-
"# Annotate a alignment result with taxonomy information from targetDB\n"
94-
"foldseek convertalis queryDB targetDB result.tsv --format-output query,target,taxid,taxname,taxlineage\n\n"
95-
" Create SAM output\n"
96-
"foldseek convertalis queryDB targetDB result.sam --format-mode 1\n\n"
97-
"# Create a TSV containing which query file a result comes from\n"
98-
"foldseek createdb euk_queries.fasta bac_queries.fasta queryDB\n"
99-
"foldseek convertalis queryDB targetDB result.tsv --format-output qset,query,target\n",
100-
"Martin Steinegger <martin.steinegger@snu.ac.kr>",
101-
"<i:queryDb> <i:targetDb> <i:alignmentDB> <o:alignmentFile>",
102-
CITATION_MMSEQS2, {{"queryDB", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA|DbType::NEED_HEADER, &DbValidator::sequenceDb },
103-
{"targetDB", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA|DbType::NEED_HEADER, &DbValidator::sequenceDb },
104-
{"alignmentDB", DbType::ACCESS_MODE_INPUT, DbType::NEED_DATA, &DbValidator::alignmentDb },
105-
{"alignmentFile", DbType::ACCESS_MODE_OUTPUT, DbType::NEED_DATA, &DbValidator::flatfile}}},
10683
{"version", versionstring, &foldmasonPar.empty, COMMAND_HIDDEN,
10784
"",
10885
NULL,

0 commit comments

Comments
 (0)