cli.commands.clean

Contents

cli.commands.clean#

showyourwork.cli.commands.clean.clean(force, deep, snakemake_args=(), cores=1, conda_frontend='conda')#

Clean the article build.

Parameters:

  • force (bool) – If True, forcefully delete files in output directories.

  • deep (bool) – If True, delete all temporary Snakemake and showyourwork directories.

  • options (str, optional) – Additional options to pass to Snakemake.

showyourwork.cli.commands.clean.onerror(func, path, exc_info)#

Error handler for shutil.rmtree.

If the error is due to an access error (read only file) it attempts to add write permission and then retries.

If the error is for another reason it re-raises the error.

Usage : shutil.rmtree(path, onerror=onerror)

Contents