annotate docs/scripts/txt/InfoSDFiles.txt @ 3:90ea638ce878 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:11:59 -0500
parents 2abf0d43254d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
2 InfoSDFiles.pl - List information about SDFile(s)
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
3
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
5 InfoSDFile.pl SDFile(s)...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
6
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
7 InfoSDFile.pl [-a --all] [-c --count] [--chiral] [--datacheck] [-d
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
8 --detail infolevel] [-e --empty] [-f, --fields] [-h, --help] [-i,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
9 --invalidatomnumbers] [-m, --mismatch] [-s, --salts] [-u,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
10 --unknownatoms] [-w, --workingdir dirname] SDFile(s)...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
11
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
12 DESCRIPTION
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
13 List information about *SDFile(s)* contents: number of compounds, empty
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
14 records and so on. Multiple SDFile names are separated by spaces. The
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
15 valid file extensions are *.sdf* and *.sd*. All other file names are
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
16 ignored. All the SD files in a current directory can be specified either
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
17 by **.sdf* or the current directory name.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
18
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
19 OPTIONS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
20 -a, --all
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
21 List all the available information.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
22
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
23 -c, --count
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
24 List number of compounds. This is default behavior.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
25
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
26 --chiral
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
27 List number of empty atom/bond blocks for compounds with chiral flag
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
28 set in count line.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
29
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
30 -d, --detail *infolevel*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
31 Level of information to print. Default: 1. Possible values: *1, 2,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
32 or 3*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
33
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
34 --datacheck
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
35 List number of numerical and non-numerical values for each data
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
36 field.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
37
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
38 -e, --empty
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
39 List number of empty atom/bond blocks and data fields for compounds.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
40
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
41 -f, --fields
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
42 List data field labels present for compounds.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
43
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
44 -h, --help
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
45 Print this help message.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
46
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
47 -i, --invalidatomnumbers
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
48 List number of bond blocks for compounds which contain invalid atom
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
49 numbers.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
50
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
51 -m, --mismatch
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
52 List number of atom/bond blocks for compounds which don't match with
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
53 counts line information in header block.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
54
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
55 -s, --salts
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
56 List number of atom blocks for compounds which contain salts
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
57 identified as disconnected structural units.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
58
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
59 -u, --unknownatoms
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
60 List number of atom blocks for compounds which contain special atom
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
61 symbols such as L, Q, * ,LP, X, R#, or any other non periodic table
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
62 symbols.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
63
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
64 -w, --workingdir *dirname*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
65 Location of working directory. Default: current directory.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
66
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
67 EXAMPLES
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
68 To count compounds in SD file(s), type:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
69
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
70 % InfoSDFiles.pl Sample1.sdf
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
71 % InfoSDFiles.pl Sample1.sdf Sample2.sdf
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
72 % InfoSDFiles.pl *.sdf
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
73
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
74 To list all available information for SD file(s), type:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
75
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
76 % InfoSDFiles.pl -a *.sdf
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
77
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
78 To list all data fields present in sample.sdf, type:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
79
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
80 % InfoSDFiles.pl -f Sample.sdf
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
81
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
82 To count number of compounds which contain salts and list associated
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
83 structural data, type:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
84
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
85 % InfoSDFiles.pl -s -d 3 Sample.sdf
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
86
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
87 AUTHOR
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
88 Manish Sud <msud@san.rr.com>
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
89
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
90 SEE ALSO
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
91 ExtractFromSDFiles.pl, FilterSDFiles.pl, MergeTextFilesWithSD.pl
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
92
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
93 COPYRIGHT
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
94 Copyright (C) 2015 Manish Sud. All rights reserved.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
95
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
96 This file is part of MayaChemTools.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
97
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
98 MayaChemTools is free software; you can redistribute it and/or modify it
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
99 under the terms of the GNU Lesser General Public License as published by
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
100 the Free Software Foundation; either version 3 of the License, or (at
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
101 your option) any later version.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
102