|
118 | 118 | geographical data). Full documentation is at
|
119 | 119 | :gmt-docs:`gmt.html#f-full`.
|
120 | 120 | """,
|
| 121 | + "i": r""" |
| 122 | + incols : str or 1d array |
| 123 | + Specify data columns for primary input in arbitrary order. Columns |
| 124 | + can be repeated and columns not listed will be skipped [Default |
| 125 | + reads all columns in order, starting with the first (i.e., column |
| 126 | + 0)]. |
| 127 | +
|
| 128 | + - For *1d array*: specify individual columns in input order (e.g., |
| 129 | + ``incols=[1,0]`` for the 2nd column followed by the 1st column). |
| 130 | + - For :py:class:`str`: specify individual columns or column |
| 131 | + ranges in the format *start*\ [:*inc*]:*stop*, where *inc* |
| 132 | + defaults to 1 if not specified, with columns and/or column ranges |
| 133 | + separated by commas (e.g., ``incols='0:2,4+l'`` to input the |
| 134 | + first three columns followed by the log-transformed 5th column). |
| 135 | + To read from a given column until the end of the record, leave |
| 136 | + off *stop* when specifying the column range. To read trailing |
| 137 | + text, add the column **t**. Append the word number to **t** to |
| 138 | + ingest only a single word from the trailing text. Instead of |
| 139 | + specifying columns, use ``incols='n'`` to simply read numerical |
| 140 | + input and skip trailing text. Optionally, append one of the |
| 141 | + following modifiers to any column or column range to transform |
| 142 | + the input columns: |
| 143 | +
|
| 144 | + - **+l** to take the *log10* of the input values. |
| 145 | + - **+d** to divide the input values by the factor *divisor* |
| 146 | + [default is 1]. |
| 147 | + - **+s** to multiple the input values by the factor *scale* |
| 148 | + [default is 1]. |
| 149 | + - **+o** to add the given *offset* to the input values [default |
| 150 | + is 0].""", |
121 | 151 | "j": r"""
|
122 | 152 | distcalc : str
|
123 | 153 | **e**\|\ **f**\|\ **g**.
|
|
0 commit comments