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
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

use crate::prelude::*;
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::{
    dataframe::{Column, NuDataFrame},
    Signature, UntaggedValue,
};

use super::utils::parse_polars_error;

pub struct DataFrame;

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

    fn usage(&self) -> &str {
        "[DataFrame] Creates a new dataframe with dummy variables"
    }

    fn signature(&self) -> Signature {
        Signature::build("dataframe to-dummies")
    }

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

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Create new dataframe with dummy variables from a dataframe",
                example: "[[a b]; [1 2] [3 4]] | dataframe to-df | dataframe to-dummies",
                result: Some(vec![NuDataFrame::try_from_columns(
                    vec![
                        Column::new(
                            "a_1".to_string(),
                            vec![UntaggedValue::int(1).into(), UntaggedValue::int(0).into()],
                        ),
                        Column::new(
                            "a_3".to_string(),
                            vec![UntaggedValue::int(0).into(), UntaggedValue::int(1).into()],
                        ),
                        Column::new(
                            "b_2".to_string(),
                            vec![UntaggedValue::int(1).into(), UntaggedValue::int(0).into()],
                        ),
                        Column::new(
                            "b_4".to_string(),
                            vec![UntaggedValue::int(0).into(), UntaggedValue::int(1).into()],
                        ),
                    ],
                    &Span::default(),
                )
                .expect("simple df for test should not fail")
                .into_value(Tag::default())]),
            },
            Example {
                description: "Create new dataframe with dummy variables from a series",
                example: "[1 2 2 3 3] | dataframe to-df | dataframe to-dummies",
                result: Some(vec![NuDataFrame::try_from_columns(
                    vec![
                        Column::new(
                            "0_1".to_string(),
                            vec![
                                UntaggedValue::int(1).into(),
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(0).into(),
                            ],
                        ),
                        Column::new(
                            "0_2".to_string(),
                            vec![
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(1).into(),
                                UntaggedValue::int(1).into(),
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(0).into(),
                            ],
                        ),
                        Column::new(
                            "0_3".to_string(),
                            vec![
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(0).into(),
                                UntaggedValue::int(1).into(),
                                UntaggedValue::int(1).into(),
                            ],
                        ),
                    ],
                    &Span::default(),
                )
                .expect("simple df for test should not fail")
                .into_value(Tag::default())]),
            },
        ]
    }
}

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

    let value = args.input.next().ok_or_else(|| {
        ShellError::labeled_error("Empty stream", "No value found in stream", &tag.span)
    })?;

    match value.value {
        UntaggedValue::DataFrame(df) => {
            let res = df.as_ref().to_dummies().map_err(|e| {
                parse_polars_error(
                    &e,
                    &tag.span,
                    Some("The only allowed column types for dummies are String or Int"),
                )
            })?;

            Ok(OutputStream::one(NuDataFrame::dataframe_to_value(res, tag)))
        }
        _ => Err(ShellError::labeled_error(
            "Incorrect type",
            "dummies cannot be done with this value",
            &value.tag.span,
        )),
    }
}

#[cfg(test)]
mod tests {
    use super::DataFrame;
    use super::ShellError;

    #[test]
    fn examples_work_as_expected() -> Result<(), ShellError> {
        use crate::examples::test_dataframe as test_examples;

        test_examples(DataFrame {})
    }
}