ExperimentType#

class pymc_marketing.mmm.experiment.ExperimentType(value)[source]#

Supported CausalPy experiment types.

Maps short aliases to CausalPy experiment class names.

Attributes:
ITSstr

Interrupted Time Series.

SCstr

Synthetic Control.

DIDstr

Difference-in-Differences.

RDstr

Regression Discontinuity.

Methods

ExperimentType.encode(/[, encoding, errors])

Encode the string using the codec registered for encoding.

ExperimentType.replace(old, new[, count])

Return a copy with all occurrences of substring old replaced by new.

ExperimentType.split(/[, sep, maxsplit])

Return a list of the substrings in the string, using sep as the separator string.

ExperimentType.rsplit(/[, sep, maxsplit])

Return a list of the substrings in the string, using sep as the separator string.

ExperimentType.join(iterable, /)

Concatenate any number of strings.

ExperimentType.capitalize(/)

Return a capitalized version of the string.

ExperimentType.casefold(/)

Return a version of the string suitable for caseless comparisons.

ExperimentType.title(/)

Return a version of the string where each word is titlecased.

ExperimentType.center(width[, fillchar])

Return a centered string of length width.

ExperimentType.count(sub[, start[, end]])

Return the number of non-overlapping occurrences of substring sub in string S[start:end].

ExperimentType.expandtabs(/[, tabsize])

Return a copy where all tab characters are expanded using spaces.

ExperimentType.find(sub[, start[, end]])

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].

ExperimentType.partition(sep, /)

Partition the string into three parts using the given separator.

ExperimentType.index(sub[, start[, end]])

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].

ExperimentType.ljust(width[, fillchar])

Return a left-justified string of length width.

ExperimentType.lower(/)

Return a copy of the string converted to lowercase.

ExperimentType.lstrip([chars])

Return a copy of the string with leading whitespace removed.

ExperimentType.rfind(sub[, start[, end]])

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].

ExperimentType.rindex(sub[, start[, end]])

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].

ExperimentType.rjust(width[, fillchar])

Return a right-justified string of length width.

ExperimentType.rstrip([chars])

Return a copy of the string with trailing whitespace removed.

ExperimentType.rpartition(sep, /)

Partition the string into three parts using the given separator.

ExperimentType.splitlines(/[, keepends])

Return a list of the lines in the string, breaking at line boundaries.

ExperimentType.strip([chars])

Return a copy of the string with leading and trailing whitespace removed.

ExperimentType.swapcase(/)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

ExperimentType.translate(table, /)

Replace each character in the string using the given translation table.

ExperimentType.upper(/)

Return a copy of the string converted to uppercase.

ExperimentType.startswith(prefix[, start[, end]])

Return True if S starts with the specified prefix, False otherwise.

ExperimentType.endswith(suffix[, start[, end]])

Return True if S ends with the specified suffix, False otherwise.

ExperimentType.removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

ExperimentType.removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

ExperimentType.isascii(/)

Return True if all characters in the string are ASCII, False otherwise.

ExperimentType.islower(/)

Return True if the string is a lowercase string, False otherwise.

ExperimentType.isupper(/)

Return True if the string is an uppercase string, False otherwise.

ExperimentType.istitle(/)

Return True if the string is a title-cased string, False otherwise.

ExperimentType.isspace(/)

Return True if the string is a whitespace string, False otherwise.

ExperimentType.isdecimal(/)

Return True if the string is a decimal string, False otherwise.

ExperimentType.isdigit(/)

Return True if the string is a digit string, False otherwise.

ExperimentType.isnumeric(/)

Return True if the string is a numeric string, False otherwise.

ExperimentType.isalpha(/)

Return True if the string is an alphabetic string, False otherwise.

ExperimentType.isalnum(/)

Return True if the string is an alpha-numeric string, False otherwise.

ExperimentType.isidentifier(/)

Return True if the string is a valid Python identifier, False otherwise.

ExperimentType.isprintable(/)

Return True if the string is printable, False otherwise.

ExperimentType.zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

ExperimentType.format(*args, **kwargs)

Return a formatted version of S, using substitutions from args and kwargs.

ExperimentType.format_map(mapping)

Return a formatted version of S, using substitutions from mapping.

ExperimentType.maketrans

ExperimentType.get_experiment_class()

Return the CausalPy experiment class for this type.

ExperimentType.__init__(*args, **kwds)

Attributes

ITS

SC

DID

RD