ProteinProspector Input Variables

All ProteinProspector programs are implemented according to the Common Gateway Interface (CGI) standard. Hence the HTML form interface can be bypassed in automated settings as long as the programs receive their input in a manner which mimics the CGI format.

To facilitate such efforts this document provides a list of all the name-value pairs associated with the input variables for each program. Future development efforts will refrain from changing these parameters unless absolutely necessary.

An alternative to using the CGI method is to run the programs from the command line. To do this each name value pair needs to be a separate argument. For example to run FA-Index from the command line on a Windows system you can use something like this:

faindex.cgi - create_database_indicies=1 database=SwissProt.11.02

On a UNIX system you should use a command of the following form (run from the directory):

./faindex.cgi - create_database_indicies=1 database=SwissProt.11.02

Note that the first argument has to be a dash character.

When doing this you need to be careful that any characters in the command line are not interpreted by the command line interpreter. For example if a value contains a space the interpreter needs some way of knowing that this isn't the next argument. To get round this any "special characters" have to be encoded. One way of doing this is to use the same encoding as that used in the CGI method.

A useful book explaining CGI programming is:

CGI Programming on the World Wide Web, Shishir Gundavaram, O'Reilly, 1996

MS-Fit MS-Tag MS-Seq MS-Pattern MS-Homology Default Value Valid Values MS-Digest MS-Bridge MS-NonSpecific MS-Product MS-Comp DB-Stat MS-Isotope FA-Index
search_name search_name search_name search_name search_name "" text which can be part of a filename. search_name search_name search_name search_name search_name search_name search_name search_name
report_title report_title report_title report_title report_title "" text report_title report_title report_title report_title report_title report_title report_title report_title
output_type output_type output_type output_type output_type HTML HTML or XML output_type output_type output_type output_type output_type output_type output_type output_type
script script script script script "" text script script script script script script script script
script_type script_type script_type script_type script_type "" text script_type script_type script_type script_type script_type script_type script_type script_type
database database database database database "" valid prefixes: Genpept, gen, SwissProt, swp, Owl, owl, Ludwignr, NCBInr, nr, dbEST, dbest, pdbEST, pdbest, DA, DN, PA, PN, pDA, pDN, Pdefault, Ddefault, pDdefault.

Unknome in MS-Tag

database database database n/a n/a database n/a database
instrument_name instrument_name instrument_name n/a n/a "" valid text strings defined in instrument.txt instrument_name instrument_name instrument_name instrument_name instrument_name n/a n/a n/a
dna_frame_translation dna_frame_translation dna_frame_translation dna_frame_translation dna_frame_translation 3 6, 3, -3, 1, -1 n/a n/a n/a n/a n/a n/a n/a n/a
results_from_file results_from_file results_from_file results_from_file results_from_file 0 0, 1 n/a n/a n/a n/a n/a results_from_file n/a results_from_file
results_input_dir results_input_dir results_input_dir results_input_dir results_input_dir "results_" + value of input_program_name parameter eg: results_msfit directory name n/a n/a n/a n/a n/a results_input_dir n/a results_input_dir
input_program_name input_program_name input_program_name input_program_name input_program_name msfit msfit, mstag, mspatternn/a n/a n/a n/a n/a input_program_namen/a input_program_name
input_filename input_filename input_filename input_filename input_filename "" text n/a n/a n/a n/a n/a input_filename n/a input_filename
indicies indicies indicies indicies indicies "" list of database indicies (integers) n/a n/a n/a n/a n/a indicies n/a indicies
accession_numbers accession_numbers accession_numbers accession_numbers accession_numbers "" list of database accession numbers n/a n/a n/a n/a n/a accession_numbers n/a accession_numbers
species species species species species All valid text strings defined in *.sp.txt or All n/a n/a n/a n/a n/a species n/a species
names names names names names None Definedlist of text stringsn/a n/a n/a n/a n/a names n/a names
accession_nums accession_nums accession_nums accession_nums accession_nums None Definedlist of text stringsn/a n/a n/a n/a n/a accession_nums n/a accession_nums
species_names species_names species_names species_names species_names None Definedlist of text stringsn/a n/a n/a n/a n/a species_names n/a species_names
species_remove species_remove species_remove species_remove species_remove 0 0, 1 n/a n/a n/a n/a n/a species_remove n/a species_remove
add_accession_numbers add_accession_numbers add_accession_numbers add_accession_numbers add_accession_numbers None Definedlist of text stringsn/a n/a n/a n/a n/a add_accession_numbersn/a add_accession_numbers
prot_low_mass prot_low_mass prot_low_mass prot_low_mass prot_low_mass 1000 integer n/a n/a n/a n/a n/a prot_low_mass n/a prot_low_mass
prot_high_mass prot_high_mass prot_high_mass prot_high_mass prot_high_mass 100000 integer n/a n/a n/a n/a n/a prot_high_mass n/a prot_high_mass
full_mw_range full_mw_range full_mw_range full_mw_range full_mw_range 0 0, 1 n/a n/a n/a n/a n/a full_mw_range n/a full_mw_range
low_pi low_pi low_pi low_pi low_pi 3.0 double n/a n/a n/a n/a n/a low_pi n/a low_pi
high_pi high_pi high_pi high_pi high_pi 10.0 double n/a n/a n/a n/a n/a high_pi n/a high_pi
full_pi_range full_pi_range full_pi_range full_pi_range full_pi_range 0 0, 1 n/a n/a n/a n/a n/a full_pi_range n/a full_pi_range
sort_type n/a n/a n/a n/a Score Sort Score Sort
MW Sort
pI Sort
n/a n/a n/a n/a n/a n/a n/a n/a
enzyme enzyme enzyme enzyme enzyme Trypsin valid text strings defined in enzyme.txt and combinations of these separated by / characters enzyme enzyme n/a n/a n/a enzyme n/a n/a
missed_cleavages missed_cleavages missed_cleavages n/a n/a 1 integer missed_cleavages missed_cleavages n/a n/a n/a n/a n/a n/a
cys cys cys cys cys acrylamide valid text strings defined in cys.txt cys cys cys cys cys n/a cys n/a
n/a n/a n/a n/a n/a 0 0, 1 end_terminus end_terminus n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a N N, C stripping_terminus stripping_terminus n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 2 integer start_strip start_strip n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 4 integer end_strip end_strip n/a n/a n/a n/a n/a n/a
comment comment comment comment comment "" text n/a n/a n/a n/a n/a n/a n/a n/a
results_to_file results_to_file results_to_file results_to_file results_to_file 0 0, 1 results_to_file results_to_file results_to_file results_to_file results_to_file results_to_file results_to_file n/a
output_dir output_dir output_dir output_dir output_dir "results_" + value of search_name parameter eg: results_msfit text output_dir output_dir output_dir output_dir output_dir output_dir output_dir output_dir
output_filename output_filename output_filename output_filename output_filename "" text output_filename output_filename output_filename output_filename output_filename output_filename output_filename output_filename
nterm nterm nterm nterm nterm Hydrogen valid text strings defined in n_terms.txt nterm nterm nterm nterm nterm n/a nterm n/a
cterm cterm cterm cterm cterm Free Acidvalid text strings defined in c_terms.txt cterm cterm cterm cterm cterm n/a cterm n/a
max_reported_hits max_reported_hits max_reported_hits max_reported_hits max_reported_hits 50 integer n/a n/a n/a n/a max_reported_hits n/a n/a n/a
n/a max_hits max_hits n/a n/a 200 integer n/a n/a n/a n/a n/a n/a n/a n/a
n/a protein_report protein_report n/a n/a 0 0,1 n/a n/a n/a n/a n/a n/a n/a n/a
detailed_report detailed_report detailed_report n/a n/a 0 0,1 n/a n/a n/a n/a n/a n/a n/a n/a
display_graph display_graph display_graph n/a n/a 0 0,1 n/a n/a n/a n/a n/a n/a n/a n/a
parent_mass_convert parent_mass_convert parent_mass_convert n/a parent_mass_convert monoisotopic monoisotopic
average
Par(mi)Frag(av)
Par(av)Frag(mi)
parent_mass_convert parent_mass_convert parent_mass_convert parent_mass_convert parent_mass_convert n/a n/a n/a
parent_mass_tolerance parent_mass_tolerance parent_mass_tolerance n/a fragment_masses_tolerance0.5 double n/a parent_mass_tolerance parent_mass_tolerance n/a parent_mass_tolerance n/a n/a n/a
tolerance_units tolerance_units tolerance_units n/a tolerance_units Da Da, %, ppm, mmu n/a tolerance_units tolerance_units tolerance_units tolerance_units n/a n/a n/a
parent_mass_systematic_errorn/a n/a n/a n/a 0.0 double n/a n/a n/a n/a n/a n/a n/a n/a
parent_contaminant_masses n/a n/a n/a n/a NULL list of singly charged masses n/a parent_contaminant_masses parent_contaminant_massesn/a n/a n/a n/a n/a
average_to_mono_convert n/a n/a n/a n/a NULL list of 0's and 1's
0 = monoisotopic
1 = average
n/a n/a n/a n/a n/a n/a n/a n/a
mod_AA n/a n/a n/a n/a None Defined Peptide N-terminal Gln to pyroGlu
Oxidation of M
Protein N-terminus Acetylated
User Defined 1
Acrylamide Modified Cys
mod_AA mod_AA n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a Cysteine Cysteine or DSS n/a link_search_type n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 5 integer n/a max_link_molecules n/a n/a n/a n/a n/a n/a
user1_name n/a n/a n/a n/a "" valid text strings defined in usermod.txt n/a n/a n/a n/a n/a n/a n/a n/a
min_parent_ion_matches n/a n/a n/a n/a 1 integer n/a n/a n/a n/a n/a n/a n/a n/a
min_matches n/a n/a n/a min_matches 5 integer n/a n/a n/a n/a n/a n/a n/a n/a
mowse_on n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a n/a
mowse_pfactor n/a n/a n/a n/a 0.4 double n/a n/a n/a n/a n/a n/a n/a n/a
chem_score n/a n/a n/a n/a 0 0, 1 chem_score chem_score n/a n/a n/a n/a n/a n/a
met_ox_factor n/a n/a n/a n/a 1.0 0.2-5.0 met_ox_factor met_ox_factor n/a n/a n/a n/a n/a n/a
data_source data_source n/a n/a n/a Data Paste Area List of Files, Upload Data From File, Data Paste Area n/a data_source data_source data_source n/a n/a n/a n/a
n/a n/a n/a n/a n/a 0 0,1 bull_breese n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 0 0,1 hplc_index n/a n/a n/a n/a n/a n/a n/a
upload_data upload_data n/a n/a n/a "" file name n/a upload_data upload_data upload_data n/a n/a n/a n/a
data_directory data_directory n/a n/a n/a "" directory name n/a n/a n/a n/a n/a n/a n/a n/a
data_files data_files n/a n/a n/a NULL list of file names n/a n/a n/a n/a n/a n/a n/a n/a
data_format data_format data_format n/a n/a "" M/Z Charge, M/Z Intensity Charge n/a data_format data_format data_format n/a n/a n/a n/a
data data data n/a n/a NULL See the data_format parameter. For MS-Tag the first line contains the m/z and optionally the charge of the parent ion. n/a data data data n/a n/a n/a n/a
search_type search_type search_type n/a n/a identity MS-Tag: identity or valid text strings
defined in homology.txt
MS-Seq: no errors, high mass error,
low mass error, middle masses error,
parent mass
n/a n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a pre_search_only n/a 0 0,1 n/a n/a n/a n/a n/a n/a n/a n/a
n/a n/a ion_type n/a n/a b a,b,c,y n/a n/a n/a n/a n/a n/a n/a n/a
n/a it n/a n/a n/a None Defineda,a-H2O,a-NH3,a-H3PO4,
b,b-H2O,b-NH3,b+H2O,
b-H3PO4,b-SOCH4,
y,y-H2O,y-NH3,y-H3PO4,y-SOCH4,
MH+,c,B,n,h,P,S,I,N,C
n/a n/a n/a it it n/a n/a n/a
n/a n/a n/a n/a n/a 0 0,1 n/a n/a n/a multiple_losses n/a n/a n/a n/a
n/a ion_unmatched_type n/a n/a n/a Max. % Unmatched Ions Max. % Unmatched Ions
Min. % Matched Ions
Max. Num Unmatched Ions
Min. Num Matched Ions
n/a n/a n/a n/a n/a n/a n/a n/a
n/a unused_ions n/a n/a n/a 10 double or integer n/a n/a n/a n/a n/a n/a n/a n/a
n/a fragment_mass_tolerancefragment_mass_tolerancen/a n/a 1.0 double n/a n/a n/a fragment_masses_tolerancen/a n/a n/a n/a
n/a comp_ion comp_ion n/a n/a None Definedregular expressioncomp_ion comp_ion n/a n/a comp_ion n/a n/a n/a
n/a n/a n/a n/a n/a AND AND or OR comp_mask_type comp_mask_type n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 1000.0 double n/a n/a n/a n/a parent_mass n/a n/a n/a
n/a n/a n/a n/a n/a 1 integer n/a n/a n/a n/a parent_charge n/a parent_charge n/a
n/a composition_search composition_search n/a n/a 0 0, 1 n/a n/a n/a n/a composition_search n/a n/a n/a
n/a exclude_flag n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a n/a
n/a aa_exclude n/a n/a n/a "" text string containing the following characters A,C,D,E,F,G,H,I,K,L,M, N,P,Q,R,S,T,V,W,Y n/a n/a n/a n/a aa_exclude n/a n/a n/a
n/a aa_add n/a n/a n/a "" m,q,h,s,t,y,u n/a n/a n/a n/a aa_add n/a n/a n/a
n/a user_aa_composition n/a n/a n/a C2 H3 N1 O1 Elemental formula of the form Cx Hy Oz etc where x, y and z are integers. Elements defined in elements.txt can be used. user_aa_composition user_aa_composition user_aa_composition user_aa_composition user_aa_composition n/a user_aa_compositionn/a
n/a user_aa_2_composition n/a n/a n/a C2 H3 N1 O1 Elemental formula of the form Cx Hy Oz etc where x, y and z are integers. Elements defined in elements.txt can be used. user_aa_2_composition user_aa_2_composition user_aa_2_composition user_aa_2_composition user_aa_2_composition n/a user_aa_2_compositionn/a
n/a user_aa_3_composition n/a n/a n/a C2 H3 N1 O1 Elemental formula of the form Cx Hy Oz etc where x, y and z are integers. Elements defined in elements.txt can be used. user_aa_3_composition user_aa_3_composition user_aa_3_composition user_aa_3_composition user_aa_3_composition n/a user_aa_3_compositionn/a
n/a user_aa_4_composition n/a n/a n/a C2 H3 N1 O1 Elemental formula of the form Cx Hy Oz etc where x, y and z are integers. Elements defined in elements.txt can be used. user_aa_4_composition user_aa_4_composition user_aa_4_composition user_aa_4_composition user_aa_4_composition n/a user_aa_4_compositionn/a
n/a n/a composition_exclude n/a n/a "" ACDEFGHIKLMNPQRSTVWY n/a n/a n/a n/a n/a n/a n/a n/a
n/a regular_expression regular_expression regular_expression n/a . regular expression n/a n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a possible_sequences possible_sequences NULL list of peptides n/a n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a max_aa_substitutions n/a 0 integer n/a n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a score_matrix 0 integer n/a n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 1 1, 2, 3, 4, 5, 6 dna_reading_frame dna_reading_frame dna_reading_frame n/a n/a dna_reading_frame n/a dna_reading_frame
n/a n/a n/a n/a n/a 1 non-zero positive integeropen_reading_frame open_reading_frame open_reading_frame n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a "" protein as a text stringuser_protein_sequence user_protein_sequence user_protein_sequence n/a n/a n/a n/a user_protein_sequence
n/a n/a n/a n/a n/a 0 0, 1 report_mult_charge n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 0 0, 1 hide_html_links n/a n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 0 0, 1 separate_proteins separate_proteins n/a n/a n/a n/a n/a hide_protein_sequence
n/a n/a n/a n/a n/a 0 0, 1 hide_protein_sequence hide_protein_sequence hide_protein_sequence n/a n/a n/a n/a hide_protein_sequence
n/a n/a n/a n/a n/a Index NumberIndex Number
Accession Number
access_method access_method access_method n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a "" See manual entry_data entry_data entry_data n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 80707 integer index_num index_num index_num n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a L39370 text accession_num accession_num accession_num n/a n/a n/a n/a accession_num
n/a n/a n/a n/a n/a 500.0 double min_digest_fragment_mass min_digest_fragment_mass n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 4000.0 double max_digest_fragment_mass max_digest_fragment_mass n/a n/a n/a n/a n/a n/a
n/a n/a n/a n/a n/a 5 integer min_digest_fragment_lengthmin_digest_fragment_lengthn/a n/a n/a n/a n/a n/a
n/a use_instrument_ion_typesn/a n/a n/a 0 0,1 n/a n/a n/a use_instrument_ion_typesn/a n/a n/a n/a
n/a n/a n/a n/a n/a 1 positive integer or No Limit n/a n/a n/a max_charge n/a n/a n/a n/a
n/a n/a n/a n/a n/a SAMPLER A,C,D,E,F,G,H,I,K,L,M,N,P,Q R,S,T,V,W,Y,m,q,h,s,t,y,u n/a n/a n/a sequence n/a n/a sequence n/a
n/a n/a n/a n/a n/a Amino AcidAmino Acid
Peptide Elemental
Elemental
n/a n/a n/a n/a combination_type n/a n/a n/a
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a show_aa_statisticsn/a n/a
n/a n/a n/a n/a n/a Peptide SequencePeptide Sequence
Elemental Composition
n/a n/a n/a n/a n/a n/a distribution_type n/a
n/a n/a n/a n/a n/a Peptide SequenceStick, Gaussian, Lorentzian n/a n/a n/a n/a n/a n/a profile_type n/a
n/a n/a n/a n/a n/a 10000.0 double n/a n/a n/a n/a n/a n/a resolution n/a
n/a n/a n/a n/a n/a 1000.0 double n/a n/a n/a n/a n/a n/a averagine_mass n/a
n/a n/a n/a n/a n/a 100.0 0.0-100.0 n/a n/a n/a n/a n/a n/a percent_C13 n/a
n/a n/a n/a n/a n/a 100.0 0.0-100.0 n/a n/a n/a n/a n/a n/a percent_N15 n/a
n/a n/a n/a n/a n/a 100.0 0.0-100.0 n/a n/a n/a n/a n/a n/a percent_O18 n/a
n/a n/a n/a n/a n/a "" Elemental formula of the form Cx Hy Oz etc where x, y and z are integers. Elements defined in elements.txt can be used. n/a n/a n/a n/a n/a n/a elemental_compositionn/a
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a detailed_report n/a
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a create_database_indicies
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a create_sub_database
n/a n/a n/a n/a n/a .sub text n/a n/a n/a n/a n/a n/a n/a sub_database_id
n/a n/a n/a n/a n/a "" text n/a n/a n/a n/a n/a n/a n/a name_field
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a create_user_database
n/a n/a n/a n/a n/a 0 integer n/a n/a n/a n/a n/a n/a n/a start_index_number
n/a n/a n/a n/a n/a 1 integer n/a n/a n/a n/a n/a n/a n/a end_index_number
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a all_indicies
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a dna_to_protein
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a delete_dna_database
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a random_database
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a reverse_database
n/a n/a n/a n/a n/a 0 0, 1 n/a n/a n/a n/a n/a n/a n/a concat_database