nu-command 0.41.0

CLI for nushell
Documentation 
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

use crate::{commands::dataframe::utils::parse_polars_error, prelude::*};
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::{dataframe::NuDataFrame, Signature, SyntaxShape};

use nu_source::Tagged;

pub struct DataFrame;

impl WholeStreamCommand for DataFrame {
    fn name(&self) -> &str {
        "dataframe sample"
    }

    fn usage(&self) -> &str {
        "[DataFrame] Create sample dataframe"
    }

    fn signature(&self) -> Signature {
        Signature::build("dataframe sample")
            .named(
                "n_rows",
                SyntaxShape::Number,
                "number of rows to be taken from dataframe",
                Some('n'),
            )
            .named(
                "fraction",
                SyntaxShape::Number,
                "fraction of dataframe to be taken",
                Some('f'),
            )
            .switch("replace", "sample with replace", Some('e'))
    }

    fn run(&self, args: CommandArgs) -> Result<OutputStream, ShellError> {
        command(args)
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Sample rows from dataframe",
                example: "[[a b]; [1 2] [3 4]] | dataframe to-df | dataframe sample -n 1",
                result: None, // No expected value because sampling is random
            },
            Example {
                description: "Shows sample row using fraction and replace",
                example:
                    "[[a b]; [1 2] [3 4] [5 6]] | dataframe to-df | dataframe sample -f 0.5 -e",
                result: None, // No expected value because sampling is random
            },
        ]
    }
}

fn command(mut args: CommandArgs) -> Result<OutputStream, ShellError> {
    let tag = args.call_info.name_tag.clone();

    let rows: Option<Tagged<usize>> = args.get_flag("n_rows")?;
    let fraction: Option<Tagged<f64>> = args.get_flag("fraction")?;
    let replace: bool = args.has_flag("replace");

    let (df, _) = NuDataFrame::try_from_stream(&mut args.input, &tag.span)?;

    let res = match (rows, fraction) {
        (Some(rows), None) => df
            .as_ref()
            .sample_n(rows.item, replace)
            .map_err(|e| parse_polars_error::<&str>(&e, &rows.tag.span, None)),
        (None, Some(frac)) => df
            .as_ref()
            .sample_frac(frac.item, replace)
            .map_err(|e| parse_polars_error::<&str>(&e, &frac.tag.span, None)),
        (Some(_), Some(_)) => Err(ShellError::labeled_error(
            "Incompatible flags",
            "Only one selection criterion allowed",
            &tag,
        )),
        (None, None) => Err(ShellError::labeled_error_with_secondary(
            "No selection",
            "No selection criterion was found",
            &tag,
            "Perhaps you want to use the flag -n or -f",
            &tag,
        )),
    }?;

    Ok(OutputStream::one(NuDataFrame::dataframe_to_value(res, tag)))
}