snakemake.rules.Rule

class snakemake.rules.Rule(name, workflow, lineno=None, snakefile=None)[source]

__init__(name, workflow, lineno=None, snakefile=None)[source]

Create a rule

Arguments name – the name of the rule

Methods

`__init__`(name, workflow[, lineno, snakefile])	Create a rule
`apply_input_function`(func, wildcards[, ...])
`apply_path_modifier`(item, path_modifier[, ...])
`check_caching`()
`check_output_duplicates`()	Check `Namedlist` for duplicate entries and raise a `WorkflowError` on problems.
`check_wildcards`(wildcards)
`expand_benchmark`(wildcards)
`expand_conda_env`(wildcards[, params, input])
`expand_group`(wildcards)	Expand the group given wildcards.
`expand_input`(wildcards[, groupid])
`expand_log`(wildcards)
`expand_output`(wildcards)
`expand_params`(wildcards, input, output, job)
`expand_resources`(wildcards, input, attempt)
`get_some_product`()
`get_wildcard_len`(wildcards)	Return the length of the given wildcard values.
`get_wildcards`(requested_output[, wildcards_dict])	Return wildcard dictionary by 1.
`has_products`()
`has_wildcards`()	Return True if rule contains wildcards.
`is_producer`(requested_output)	Returns True if this rule is a producer of the requested output.
`products`([include_logfiles])
`register_wildcards`(wildcard_names)
`set_input`(input, *kwinput)	Add a list of input files.
`set_log`(logs, *kwlogs)
`set_output`(output, *kwoutput)	Add a list of output files.
`set_params`(params, *kwparams)
`set_wildcard_constraints`(...)
`update_wildcard_constraints`()

Attributes