lmutils 0.2.92

A set of utilities for working with linear regression models
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
#![allow(
    dead_code,
    unused,
    clippy::excessive_precision,
    clippy::uninlined_format_args
)]
mod aic;
mod binom;
mod calc;
mod coef;
mod elnet;
mod error;
mod file;
mod gam;
mod glm;
pub mod ld;
mod lm;
mod mat;
mod matrix;
mod mean;
mod norm;
mod packing;
mod r2;
mod spline;
mod standardize;
mod sum;
mod variance;

use std::{mem::MaybeUninit, panic::AssertUnwindSafe, sync::Mutex};

use rayon::prelude::*;
use tracing::{debug, debug_span, error, info, trace, warn};

pub use crate::{
    aic::*, binom::*, calc::*, coef::*, elnet::*, error::*, file::*, glm::*, lm::*, matrix::*,
    mean::*, norm::*, packing::*, r2::*, standardize::*, sum::*, variance::*,
};

#[cfg_attr(coverage_nightly, coverage(off))]
#[doc(hidden)]
pub fn core_parallelize<T, F, R, E>(data: Vec<T>, out: Option<usize>, f: F) -> Result<Vec<R>, E>
where
    T: Send + Sync,
    for<'a> F: (Fn(usize, &'a mut T) -> Result<Vec<R>, E>) + Send + Sync,
    R: Send + Sync,
    E: std::error::Error,
{
    let mut core_parallelism = std::env::var("LMUTILS_CORE_PARALLELISM")
        .ok()
        .or_else(|| std::env::var("LMUTILS_NUM_MAIN_THREADS").ok())
        .and_then(|x| x.parse::<usize>().ok())
        .unwrap_or(16);
    if core_parallelism > data.len() {
        core_parallelism = data.len();
    }
    if core_parallelism == 0 {
        core_parallelism = 1;
    }
    if core_parallelism > num_cpus::get() {
        core_parallelism = num_cpus::get();
    }
    let ignore_errors = std::env::var("LMUTILS_IGNORE_CORE_PARALLEL_ERRORS")
        .ok()
        .map(|x| x == "1")
        .unwrap_or(true);

    let mut results_uninit = if let Some(out) = out {
        // if there's a known output size, we can preallocate the results and guarantee
        // an order
        let mut results: Vec<MaybeUninit<R>> = Vec::with_capacity(out * data.len());
        results.extend((0..(out * data.len())).map(|_| MaybeUninit::uninit()));
        Some(results)
    } else {
        // if there isn't, then we can't guarantee an order, so we just return None
        None
    };
    let mut results_push = if out.is_none() {
        Some(Mutex::new(Vec::new()))
    } else {
        None
    };

    let data = Mutex::new(data.into_iter().enumerate().collect::<Vec<_>>());

    std::thread::scope(|s| {
        for _ in 0..core_parallelism {
            s.spawn(|| loop {
                let mut guard = data.lock().unwrap();
                let d = guard.pop();
                drop(guard);
                if let Some((i, mut d)) = d {
                    rayon::scope(|s| {
                        s.spawn(|_| {
                            let s = debug_span!("core_scope");
                            let _e = s.enter();
                            let mut tries = 1;
                            #[allow(clippy::blocks_in_conditions)]
                            while std::panic::catch_unwind(AssertUnwindSafe(|| {
                                let r = f(i, &mut d).unwrap();
                                if let Some(out) = out {
                                    let results = unsafe {
                                        std::slice::from_raw_parts_mut(
                                            results_uninit
                                                .as_ref()
                                                .unwrap()
                                                .as_ptr()
                                                .add(i * out)
                                                .cast_mut(),
                                            out,
                                        )
                                    };
                                    for (i, p) in r.into_iter().enumerate() {
                                        results[i].write(p);
                                    }
                                } else {
                                    let mut results =
                                        results_push.as_ref().unwrap().lock().unwrap();
                                    results.extend(r);
                                }
                            }))
                            .is_err()
                            {
                                let duration = std::time::Duration::from_secs(4u64.pow(tries));
                                warn!(
                                    "Error in core scope, retrying in {} seconds",
                                    duration.as_secs_f64()
                                );
                                std::thread::sleep(duration);
                                tries += 1;
                                if tries > 4 {
                                    if ignore_errors {
                                        error!("Error in core scope, ignoring");
                                        break;
                                    } else {
                                        error!("Error in core scope, too many retries");
                                        panic!("Error in core scope, too many retries");
                                    }
                                }
                            }
                        })
                    })
                } else {
                    break;
                }
            });
        }
    });

    Ok(if let Some(out) = out {
        // SAFETY: We have initialized all elements of the array.
        unsafe { std::mem::transmute::<Vec<MaybeUninit<R>>, Vec<R>>(results_uninit.unwrap()) }
    } else {
        results_push.unwrap().into_inner().unwrap()
    })
}

// Calculate R^2 and adjusted R^2 for a list of data and outcomes.
#[tracing::instrument(skip(data, outcomes, data_names))]
pub fn calculate_r2s(
    mut data: Vec<Matrix>,
    mut outcomes: Matrix,
    data_names: Option<Vec<&str>>,
) -> Result<Vec<R2>, crate::Error> {
    outcomes.remove_column_by_name_if_exists("eid");
    outcomes.remove_column_by_name_if_exists("IID");
    let colnames = outcomes
        .colnames()?
        .map(|x| x.into_iter().map(|x| x.to_string()).collect::<Vec<_>>());
    debug!("Loading outcomes");
    let or = outcomes.as_mat_ref()?;
    debug!("Loaded outcomes");
    // let data = Mutex::new(
    //     data.into_iter()
    //         .enumerate()
    //         .map(|(i, m)| m.make_parallel_safe().map(|m| (i, m)))
    //         .collect::<Result<Vec<_>, _>>()?,
    // );
    // let ndata = data.lock().unwrap().len();
    // let mut results: Vec<MaybeUninit<R2>> = Vec::with_capacity(or.ncols() *
    // ndata); results.extend((0..(or.ncols() * ndata)).map(|_|
    // MaybeUninit::uninit()));
    let data_names = match data_names {
        Some(data_names) if data_names.iter().all(|x| *x == "NA") => None,
        x => x,
    };
    core_parallelize(data, Some(or.ncols()), |i, mat| {
        let data_set = if let Some(data_names) = &data_names {
            data_names[i].to_string()
        } else {
            (i + 1).to_string()
        };
        info!("Calculating R^2 for data set {}", data_set);
        let mut mat = if !mat.is_loaded() {
            info!("Loading data set {}", data_set);
            let mat = mat.to_owned()?;
            info!("Loaded data set {}", data_set);
            mat
        } else {
            info!("Data set {} already loaded", data_set);
            mat.to_owned()?
        };
        if mat.has_column_loaded("eid") || mat.has_column_loaded("IID") {
            mat.remove_column_by_name_if_exists("eid")?;
            mat.remove_column_by_name_if_exists("IID")?;
        }
        let r = mat.as_mat_ref_loaded();
        if r.ncols() == 0 || r.nrows() == 0 {
            warn!(
                "Data set {} has no columns or no rows, skipping",
                if let Some(data_names) = &data_names {
                    data_names[i].to_string()
                } else {
                    (i + 1).to_string()
                }
            );
            return Ok((0..or.ncols())
                .map(|_| R2 {
                    r2: 0.0,
                    adj_r2: 0.0,
                    predicted: vec![],
                    betas: vec![],
                    data: None,
                    outcome: None,
                    n: 0,
                    m: 0,
                })
                .collect::<Vec<_>>());
        }
        let r2s = get_r2s(r, or)
            .into_iter()
            .enumerate()
            .map(|(j, mut r)| {
                if let Some(data_names) = &data_names {
                    r.data = Some(data_names[i].to_string());
                } else {
                    r.data = Some((i + 1).to_string());
                }
                r.outcome = colnames
                    .as_ref()
                    .and_then(|c| c.get(j).map(|c| c.to_string()))
                    .or_else(|| Some((j + 1).to_string()));
                r
            })
            .collect::<Vec<_>>();
        info!(
            "Finished calculating R^2 for data set {}",
            if let Some(data_names) = &data_names {
                data_names[i].to_string()
            } else {
                i.to_string()
            }
        );
        mat.unload();
        Ok(r2s)
    })
    .map(|x| {
        x.into_iter()
            .filter(|x| x.n > 0 && x.m > 0)
            .collect::<Vec<_>>()
    })
}

#[tracing::instrument(skip(data, outcomes, data_names))]
pub fn column_p_values(
    mut data: Vec<Matrix>,
    mut outcomes: Matrix,
    data_names: Option<Vec<&str>>,
) -> Result<Vec<PValue>, crate::Error> {
    outcomes.remove_column_by_name_if_exists("eid");
    outcomes.remove_column_by_name_if_exists("IID");
    let colnames = outcomes
        .colnames()?
        .map(|x| x.into_iter().map(|x| x.to_string()).collect::<Vec<_>>());
    let or = outcomes.as_mat_ref()?;
    // let data = Mutex::new(
    //     data.into_iter()
    //         .enumerate()
    //         .map(|(i, m)| m.make_parallel_safe().map(|m| (i, m)))
    //         .collect::<Result<Vec<_>, _>>()?,
    // );
    // let ndata = or.nrows();
    // let mut results: Vec<MaybeUninit<PValue>> = Vec::with_capacity(or.ncols() *
    // ndata); results.extend((0..(or.ncols() * ndata)).map(|_|
    // MaybeUninit::uninit()));
    core_parallelize(data, None, |i, mat| {
        info!(
            "Calculating p-values for data set {}",
            if let Some(data_names) = &data_names {
                data_names[i].to_string()
            } else {
                (i + 1).to_string()
            }
        );
        if !mat.is_loaded() {
            mat.into_owned()?;
        }
        if mat.has_column_loaded("eid") || mat.has_column_loaded("IID") {
            mat.remove_column_by_name_if_exists("eid")?;
            mat.remove_column_by_name_if_exists("IID")?;
        }
        let data = mat.as_mat_ref_loaded();
        let p_values = (0..data.ncols())
            .into_par_iter()
            .flat_map(|x| {
                let xs = data
                    .get(.., x)
                    .try_as_col_major()
                    .expect("could not get slice")
                    .as_slice();
                (0..or.ncols()).into_par_iter().map(move |y| {
                    let ys = or
                        .get(.., y)
                        .try_as_col_major()
                        .expect("could not get slice")
                        .as_slice();
                    (x, y, p_value(xs, ys))
                })
            })
            .map(|(x, y, mut p)| {
                if let Some(data_names) = &data_names {
                    p.data = Some(data_names[i].to_string());
                } else {
                    p.data = Some((i + 1).to_string());
                }
                p.data_column = Some((x + 1) as u32);
                p.outcome = colnames
                    .as_ref()
                    .and_then(|c| c.get(y).map(|c| c.to_string()))
                    .or_else(|| Some((y + 1).to_string()));
                p
            })
            .collect::<Vec<_>>();
        info!(
            "Finished calculating p-values for data set {}",
            if let Some(data_names) = &data_names {
                data_names[i].to_string()
            } else {
                i.to_string()
            }
        );
        mat.unload();
        Ok(p_values)
    })
}

pub fn compute_r2(actual: &[f64], predicted: &[f64]) -> f64 {
    R2Simd::new(actual, predicted).calculate()
}

#[cfg(test)]
mod tests {
    use test_log::test;

    use super::*;

    #[test]
    fn test_calculate_r2s() {
        let mut m1 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            None,
        ));
        let mut m2 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            None,
        ));
        let mut m3 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            None,
        ));
        let results = calculate_r2s(vec![m1, m2], m3, None).unwrap();
        assert_eq!(results.len(), 6);
    }

    #[test]
    fn test_calculate_r2s_names() {
        let mut m1 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            Some(vec!["a".to_string(), "b".to_string(), "c".to_string()]),
        ));
        let mut m2 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            Some(vec!["d".to_string(), "e".to_string(), "f".to_string()]),
        ));
        let mut m3 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            Some(vec!["g".to_string(), "h".to_string(), "i".to_string()]),
        ));
        let results = calculate_r2s(vec![m1, m2], m3, Some(vec!["j", "k"])).unwrap();
        assert_eq!(results.len(), 6);
    }

    #[test]
    fn test_column_p_values() {
        let mut m1 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            None,
        ));
        let mut m2 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            None,
        ));
        let mut m3 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            None,
        ));
        let results = column_p_values(vec![m1, m2], m3, None).unwrap();
        assert_eq!(results.len(), 18);
    }

    #[test]
    fn test_column_p_values_names() {
        let mut m1 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            Some(vec!["a".to_string(), "b".to_string(), "c".to_string()]),
        ));
        let mut m2 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            Some(vec!["d".to_string(), "e".to_string(), "f".to_string()]),
        ));
        let mut m3 = Matrix::Owned(OwnedMatrix::new(
            3,
            3,
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0],
            Some(vec!["g".to_string(), "h".to_string(), "i".to_string()]),
        ));
        let results = column_p_values(vec![m1, m2], m3, Some(vec!["j", "k"])).unwrap();
        assert_eq!(results.len(), 18);
    }
}