source: branches/tree/HELP_SOURCE/source/arb_export.hlp

Last change on this file was 18769, checked in by westram, 3 years ago
  • move all helpfiles to new source location
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.4 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3UP      glossary.hlp
4UP      mark.hlp
5UP      nt_align_select.hlp
6
7#Please insert subtopic references  (line starts with keyword SUB)
8#SUB    export_format.hlp
9SUB     arb_import.hlp
10
11# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
12
13#************* Title of helpfile !! and start of real helpfile ********
14TITLE           Export Selected Species and Sequences
15
16OCCURRENCE      ARB_NT/File/Export/Export to external format
17
18DESCRIPTION
19                Exports the selected 'alignment' of some or all 'species' in
20                various formats.
21
22                Select a format from the format list.
23
24                Select a field transfer set (FTS) if you like to select or modify
25                the data to be exported.
26
27                Choose whether to export all or only marked species.
28
29                Choose a filter to export only selected columns.
30
31                Select a compression method:
32                       - 'none' preserves the alignment information
33                       - 'vertical gaps' removes all columns containing only gaps
34                       - 'all gaps' completely remove the alignment information
35
36                Check 'Cut stop codon' to cut off the sequence at the stop codon.
37
38                Define whether the data should be written to one or to multiple
39                        files by clicking on the checkbox after the 'Should the
40                        data be written to multiple files:' prompt. In the
41                        multiple file mode, each 'species' is written to its own
42                        file.
43
44                Define an output file name by selecting from the 'Directories
45                        and Files' subwindow or by typing it to the 'Output File
46                        Name' subwindow. In the multiple file mode, the
47                        resulting filenames are created by appending the
48                        'species name' to the specified output filename
49                        separated by underscores (filename_species name).
50
51                Press the <GO> button
52
53
54SECTION         Export filters
55
56                Default export filters available for all users are stored in
57                directory $ARBHOME/lib/export/*.eft.
58
59                ARB reads the selected format and replaces all references to
60                species fields by the value of the referred field.
61                See LINK{export_format.hlp} for more information.
62
63                Specifying a FTS will (virtually) modify the contents of fields
64                used in the export filter.
65                Note: this will NOT affect the fields original content, it just
66                is a temporary change, visible only to the export filter.
67
68                    Simple example: if the export filter accesses the field 'author' and
69                    you use some arb database where the author is stored
70                    in the field 'autref', you may create a FTS containing one simple
71                    forwarding rule "autref -> author".
72
73                    The content of field 'autref' will be exported
74                    whenever 'author' is accessed (but your database will
75                    not get modified).
76
77                    This FTS can be used with any export form that uses 'author'.
78
79
80SECTION         Custom export filters
81
82                You may create and store your own private export filters in
83                directory '~/.arb_prop/filter'.
84                See LINK{export_format.hlp} for information
85                about the export filter definition language.
86
87                Press the 'Test' button to modify and test the selected filter
88                (see LINK{export_test.hlp}).
89
90NOTES           None
91
92EXAMPLES        None
93
94BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.