Changeset 37572 in project


Ignore:
Timestamp:
05/02/19 01:10:47 (3 weeks ago)
Author:
iraikov
Message:

dataframe doc: markup fixes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/dataframe

    r37571 r37572  
    88== Documentation
    99
    10 The <code>dataframe</code> library provides an interface for
     10The {{dataframe}} library provides an interface for
    1111representing numerical data in tables with rows and columns. It is
    1212inspired by the various dataframe implementations found in R, Python
    1313and Racket.
    1414
    15 The <code>dataframe</code> library also provides functions for loading
     15The {{dataframe}} library also provides functions for loading
    1616and saving data from data frames as well as routines for descriptive
    1717statistics and linear regression.
     
    2424on columns.
    2525
    26 <procedure>
    27 (column? obj)
    28 </procedure>
     26<procedure>(column? obj)</procedure>
    2927Returns true if the given object is a column.
    3028
    31 <procedure>
    32 (get-column-properties column)
    33 </procedure>
     29<procedure>(get-column-properties column)</procedure>
    3430Returns an associative list with column properties.
    3531
    36 <procedure>
    37 (get-column-key column)
    38 </procedure>
     32<procedure>(get-column-key column)</procedure>
    3933Returns the key of the column.
    4034
    41 <procedure>
    42 (get-column-collection column)
    43 </procedure>
     35<procedure>(get-column-collection column)</procedure>
    4436Returns the data collection of the column.
    4537
    46 <procedure>
    47 (column-deserialize column port)
    48 </procedure>
     38<procedure>(column-deserialize column port)</procedure>
    4939Loads the data collection of a column from the given port.
    5040
    51 <procedure>
    52 (column-serialize column port)
    53 </procedure>
     41<procedure>(column-serialize column port)</procedure>
    5442Stores the data collection of a column to the given port in an s-expression format.
    5543
    5644=== Creating data frames
    5745
    58 <procedure>
    59 (make-data-frame [column-key-compare: compare-symbol])
    60 </procedure>
     46<procedure>(make-data-frame [column-key-compare: compare-symbol])</procedure>
    6147Creates a new dataframe, with optional argument a procedure that specifies how to compare column keys. Default is comparison on symbols. Returns the new dataframe.
    6248
    63 <procedure>
    64 (df-insert-column df key collection properties)
    65 </procedure>
     49<procedure>(df-insert-column df key collection properties)</procedure>
    6650Inserts a new column with the given key, data collection, and properties. Returns a new dataframe with the inserted column.
    6751
    68 <procedure>
    69 (df-insert-derived df parent-key key proc properties)
    70 </procedure>
     52<procedure>(df-insert-derived df parent-key key proc properties)</procedure>
    7153Inserts a derived column, that is a column whose data elements are obtained by mapping a procedure onto the elements of an existing (parent) column. Returns a new dataframe with the inserted column.
    7254
    73 <procedure>
    74 (df-insert-columns df lseq)
    75 </procedure>
     55<procedure>(df-insert-columns df lseq)</procedure>
    7656Inserts the columns contained in the given lseq of column objects.
    7757
    7858=== Accessing data frames
    7959
    80 <procedure>
    81 (show df)
    82 </procedure>
     60<procedure>(show df)</procedure>
    8361Displays a subset of the rows and columns contained in the dataframe.
    8462
    85 <procedure>
    86 (row-count df)
    87 </procedure>
     63<procedure>(row-count df)</procedure>
    8864Returns the number of rows in the dataframe.
    8965
    90 <procedure>
    91 (df-column df key)
    92 </procedure>
     66<procedure>(df-column df key)</procedure>
    9367Returns the column indicated by the given key.
    9468
    95 <procedure>
    96 (df-columns df)
    97 </procedure>
     69<procedure>(df-columns df)</procedure>
    9870Returns a lazy sequence containing the columns of the dataframe.
    9971
    100 <procedure>
    101 (df-filter-columns df proc)
    102 </procedure>
     72<procedure>(df-filter-columns df proc)</procedure>
    10373Returns a filtered lseq of the columns of the dataframe according to the given filter predicate procedure.
    10474
    105 <procedure>
    106 (df-select-columns df keys)
    107 </procedure>
     75<procedure>(df-select-columns df keys)</procedure>
    10876Returns an lseq of the columns of the dataframe that have the keys enumerated in the given list of keys.
    10977
    110 <procedure>
    111 (df-keys df)
    112 </procedure>
     78<procedure>(df-keys df)</procedure>
    11379Returns the keys of all columns in the dataframe.
    11480
    115 <procedure>
    116 (df-items df)
    117 </procedure>
     81<procedure>(df-items df)</procedure>
    11882Returns an lseq of the key-column pairs contained in the dataframe.
    11983
    120 <procedure>
    121 (apply-collections proc df key ...)
    122 </procedure>
     84<procedure>(apply-collections proc df key ...)</procedure>
    12385Applies the given procedure to the data collections of the named columns of the dataframe and returns the result as a list.
    12486
    125 <procedure>
    126 (apply-columns proc df key ...)
    127 </procedure>
     87<procedure>(apply-columns proc df key ...)</procedure>
    12888Applies the given procedure to the named columns of the dataframe and returns the result as a list.
    12989
    130 <procedure>
    131 (map-collections proc df key ...)
    132 </procedure>
     90<procedure>(map-collections proc df key ...)</procedure>
    13391Applies the given procedure to the data collections of the named columns of the dataframe and returns the result as a dataframe.
    13492
    135 <procedure>
    136 (map-columns proc df key ...)
    137 </procedure>
     93<procedure>(map-columns proc df key ...)</procedure>
    13894Applies the given procedure to the named columns of the dataframe and returns the result as a dataframe.
    13995
    140 <procedure>
    141 (reduce-collections proc df seed key ...)
    142 </procedure>
     96<procedure>(reduce-collections proc df seed key ...)</procedure>
    14397Fold over the data collections of the named columns.
    14498
    14599=== Iterators
    146100
    147 <procedure>
    148 (df-for-each-column df proc)
    149 </procedure>
     101<procedure>(df-for-each-column df proc)</procedure>
    150102Applies proc to each column.
    151103
    152 <procedure>
    153 (df-for-each-collection df proc)
    154 </procedure>
     104<procedure>(df-for-each-collection df proc)</procedure>
    155105Applies proc to the data collection of each column.
    156106
    157 <procedure>
    158 (df-gen-rows df)
    159 </procedure>
     107<procedure>(df-gen-rows df)</procedure>
    160108Returns a generator procedure that returns the dataframe rows in succession.
    161109
    162 <procedure>
    163 (df-gen-columns df)
    164 </procedure>
     110<procedure>(df-gen-columns df)</procedure>
    165111Returns a generator procedure the returns the dataframe columns in succession.
    166112
    167113=== Descriptive statistics
    168114
    169 <procedure>
    170 (describe df port)
    171 </procedure>
     115<procedure>(describe df port)</procedure>
    172116Displays a table with the min/max/mean/sdev of each column in the dataframe.
    173117
    174 <procedure>
    175 (cmin df)
    176 </procedure>
     118<procedure>(cmin df)</procedure>
    177119Computes the minimum value of each column.
    178120
    179 <procedure>
    180 (cmax df)
    181 </procedure>
     121<procedure>(cmax df)</procedure>
    182122Computes the maximum value of each column.
    183123
    184 <procedure>
    185 (mean df)
    186 </procedure>
     124<procedure>(mean df)</procedure>
    187125Computes the mean value of each column.
    188126
    189 <procedure>
    190 (median df)
    191 </procedure>
     127<procedure>(median df)</procedure>
    192128Computes the median value of each column.
    193129
    194 <procedure>
    195 (mode df)
    196 </procedure>
     130<procedure>(mode df)</procedure>
    197131Computes the mode value of each column.
    198132
    199 <procedure>
    200 (range df)
    201 </procedure>
     133<procedure>(range df)</procedure>
    202134Computes the difference between maximum and minimum value of each column.
    203135
    204 <procedure>
    205 (percentile df)
    206 </procedure>
     136<procedure>(percentile df)</procedure>
    207137Computes the percentile values of each column.
    208138
    209 <procedure>
    210 (variance df)
    211 </procedure>
     139<procedure>(variance df)</procedure>
    212140Computes the variance of each column.
    213141
    214 <procedure>
    215 (standard-deviation df)
    216 </procedure>
     142<procedure>(standard-deviation df)</procedure>
    217143Computes the standard deviation of each column.
    218144
    219 <procedure>
    220 (coefficient-of-variation df)
    221 </procedure>
     145<procedure>(coefficient-of-variation df)</procedure>
    222146Computes the coefficient of variation of each column.
    223147
    224148=== Regression and correlation
    225149
    226 <procedure>
    227 (linear-regression df x y)
    228 </procedure>
     150<procedure>(linear-regression df x y)</procedure>
    229151Linear regression between columns x and y.
    230152
    231 <procedure>
    232 (correlation-coefficient df x y)
    233 </procedure>
     153<procedure>(correlation-coefficient df x y)</procedure>
    234154Correlation coefficient between columns x and y.
    235155
    236156=== I/O
    237157
    238 <procedure>
    239 (df-serialize df port)
    240 </procedure>
     158<procedure>(df-serialize df port)</procedure>
    241159Stores the dataframe in an s-expression format to the given port.
    242160
    243 <procedure>
    244 (df-deserialize df port)
    245 </procedure>
     161<procedure>(df-deserialize df port)</procedure>
    246162Loads the data collections of the dataframe columns from the given port.
    247163
Note: See TracChangeset for help on using the changeset viewer.