Dominican Republic Invoice Numbers

Introduction

The function clean_do_ncf() cleans a column containing Dominican Republic invoice number (NCF) strings, and standardizes them in a given format. The function validate_do_ncf() validates either a single NCF strings, a column of NCF strings or a DataFrame of NCF strings, returning True if the value is valid, and False otherwise.

NCF strings can be converted to the following formats via the output_format parameter:

  • compact: only number strings without any seperators or whitespace, like “E310000000005”

  • standard: NCF strings with proper whitespace in the proper places. Note that in the case of NCF, the compact format is the same as the standard one.

Invalid parsing is handled with the errors parameter:

  • coerce (default): invalid parsing will be set to NaN

  • ignore: invalid parsing will return the input

  • raise: invalid parsing will raise an exception

The following sections demonstrate the functionality of clean_do_ncf() and validate_do_ncf().

An example dataset containing NCF strings

[1]:
import pandas as pd
import numpy as np
df = pd.DataFrame(
    {
        "ncf": [
            'E310000000005',
            'Z0100000005',
            'BE 428759497',
            'BE431150351',
            "002 724 334",
            "hello",
            np.nan,
            "NULL",
        ],
        "address": [
            "123 Pine Ave.",
            "main st",
            "1234 west main heights 57033",
            "apt 1 789 s maple rd manhattan",
            "robie house, 789 north main street",
            "1111 S Figueroa St, Los Angeles, CA 90015",
            "(staples center) 1111 S Figueroa St, Los Angeles",
            "hello",
        ]
    }
)
df
[1]:
ncf address
0 E310000000005 123 Pine Ave.
1 Z0100000005 main st
2 BE 428759497 1234 west main heights 57033
3 BE431150351 apt 1 789 s maple rd manhattan
4 002 724 334 robie house, 789 north main street
5 hello 1111 S Figueroa St, Los Angeles, CA 90015
6 NaN (staples center) 1111 S Figueroa St, Los Angeles
7 NULL hello

1. Default clean_do_ncf

By default, clean_do_ncf will clean ncf strings and output them in the standard format with proper separators.

[2]:
from dataprep.clean import clean_do_ncf
clean_do_ncf(df, column = "ncf")
[2]:
ncf address ncf_clean
0 E310000000005 123 Pine Ave. E310000000005
1 Z0100000005 main st NaN
2 BE 428759497 1234 west main heights 57033 NaN
3 BE431150351 apt 1 789 s maple rd manhattan NaN
4 002 724 334 robie house, 789 north main street NaN
5 hello 1111 S Figueroa St, Los Angeles, CA 90015 NaN
6 NaN (staples center) 1111 S Figueroa St, Los Angeles NaN
7 NULL hello NaN

2. Output formats

This section demonstrates the output parameter.

standard (default)

[3]:
clean_do_ncf(df, column = "ncf", output_format="standard")
[3]:
ncf address ncf_clean
0 E310000000005 123 Pine Ave. E310000000005
1 Z0100000005 main st NaN
2 BE 428759497 1234 west main heights 57033 NaN
3 BE431150351 apt 1 789 s maple rd manhattan NaN
4 002 724 334 robie house, 789 north main street NaN
5 hello 1111 S Figueroa St, Los Angeles, CA 90015 NaN
6 NaN (staples center) 1111 S Figueroa St, Los Angeles NaN
7 NULL hello NaN

compact

[4]:
clean_do_ncf(df, column = "ncf", output_format="compact")
[4]:
ncf address ncf_clean
0 E310000000005 123 Pine Ave. E310000000005
1 Z0100000005 main st NaN
2 BE 428759497 1234 west main heights 57033 NaN
3 BE431150351 apt 1 789 s maple rd manhattan NaN
4 002 724 334 robie house, 789 north main street NaN
5 hello 1111 S Figueroa St, Los Angeles, CA 90015 NaN
6 NaN (staples center) 1111 S Figueroa St, Los Angeles NaN
7 NULL hello NaN

3. inplace parameter

This deletes the given column from the returned DataFrame. A new column containing cleaned NCF strings is added with a title in the format "{original title}_clean".

[5]:
clean_do_ncf(df, column="ncf", inplace=True)
[5]:
ncf_clean address
0 E310000000005 123 Pine Ave.
1 NaN main st
2 NaN 1234 west main heights 57033
3 NaN apt 1 789 s maple rd manhattan
4 NaN robie house, 789 north main street
5 NaN 1111 S Figueroa St, Los Angeles, CA 90015
6 NaN (staples center) 1111 S Figueroa St, Los Angeles
7 NaN hello

4. errors parameter

coerce (default)

[6]:
clean_do_ncf(df, "ncf", errors="coerce")
[6]:
ncf address ncf_clean
0 E310000000005 123 Pine Ave. E310000000005
1 Z0100000005 main st NaN
2 BE 428759497 1234 west main heights 57033 NaN
3 BE431150351 apt 1 789 s maple rd manhattan NaN
4 002 724 334 robie house, 789 north main street NaN
5 hello 1111 S Figueroa St, Los Angeles, CA 90015 NaN
6 NaN (staples center) 1111 S Figueroa St, Los Angeles NaN
7 NULL hello NaN

ignore

[7]:
clean_do_ncf(df, "ncf", errors="ignore")
[7]:
ncf address ncf_clean
0 E310000000005 123 Pine Ave. E310000000005
1 Z0100000005 main st Z0100000005
2 BE 428759497 1234 west main heights 57033 BE 428759497
3 BE431150351 apt 1 789 s maple rd manhattan BE431150351
4 002 724 334 robie house, 789 north main street 002 724 334
5 hello 1111 S Figueroa St, Los Angeles, CA 90015 hello
6 NaN (staples center) 1111 S Figueroa St, Los Angeles NaN
7 NULL hello NaN

4. validate_do_ncf()

validate_do_ncf() returns True when the input is a valid NCF. Otherwise it returns False.

The input of validate_do_ncf() can be a string, a Pandas DataSeries, a Dask DataSeries, a Pandas DataFrame and a dask DataFrame.

When the input is a string, a Pandas DataSeries or a Dask DataSeries, user doesn’t need to specify a column name to be validated.

When the input is a Pandas DataFrame or a dask DataFrame, user can both specify or not specify a column name to be validated. If user specify the column name, validate_do_ncf() only returns the validation result for the specified column. If user doesn’t specify the column name, validate_do_ncf() returns the validation result for the whole DataFrame.

[8]:
from dataprep.clean import validate_do_ncf
print(validate_do_ncf("E310000000005"))
print(validate_do_ncf("Z0100000005"))
print(validate_do_ncf('BE 428759497'))
print(validate_do_ncf('BE431150351'))
print(validate_do_ncf("004085616"))
print(validate_do_ncf("hello"))
print(validate_do_ncf(np.nan))
print(validate_do_ncf("NULL"))
True
False
False
False
False
False
False
False

Series

[9]:
validate_do_ncf(df["ncf"])
[9]:
0     True
1    False
2    False
3    False
4    False
5    False
6    False
7    False
Name: ncf, dtype: bool

DataFrame + Specify Column

[10]:
validate_do_ncf(df, column="ncf")
[10]:
0     True
1    False
2    False
3    False
4    False
5    False
6    False
7    False
Name: ncf, dtype: bool

Only DataFrame

[11]:
validate_do_ncf(df)
[11]:
ncf address
0 True False
1 False False
2 False False
3 False False
4 False False
5 False False
6 False False
7 False False
[ ]: