Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: make it possible to set input as files or dirs to multiqc #488

Merged
merged 6 commits into from May 16, 2022

Conversation

Smeds
Copy link
Contributor

@Smeds Smeds commented May 13, 2022

make it possible to use the actual input from the rule as input to multiqc, instead of converting it to dirs that are then searched.

Description

If multiqc search directories it's possible that unwanted files are included to the reports. This will make it possible to only use the provided files, when wanted.

For all wrappers added by this PR, I made sure that

  • there is a test case which covers any introduced changes,
  • input: and output: file paths in the resulting rule can be changed arbitrarily,
  • either the wrapper can only use a single core, or the example rule contains a threads: x statement with x being a reasonable default,
  • rule names in the test case are in snake_case and somehow tell what the rule is about or match the tools purpose or name (e.g., map_reads for a step that maps reads),
  • all environment.yaml specifications follow the respective best practices,
  • wherever possible, command line arguments are inferred and set automatically (e.g. based on file extensions in input: or output:),
  • all fields of the example rules in the Snakefiles and their entries are explained via comments (input:/output:/params: etc.),
  • stderr and/or stdout are logged correctly (log:), depending on the wrapped tool,
  • temporary files are either written to a unique hidden folder in the working directory, or (better) stored where the Python function tempfile.gettempdir() points to (see here; this also means that using any Python tempfile default behavior works),
  • the meta.yaml contains a link to the documentation of the respective tool or command,
  • Snakefiles pass the linting (snakemake --lint),
  • Snakefiles are formatted with snakefmt,
  • Python wrapper scripts are formatted with black.

make it possible to use the actual input from the rule as input to multiqc, instead of converting it to dirs that are then searched.
@fgvieira
Copy link
Collaborator

I find the variable name convert_file_input_to_dirs a bit confusing. Could we have something a bit simpler, like (e.g.) use_input_files_only, use_input_dirs, scan_input_dirs?

Smeds and others added 3 commits May 13, 2022 15:55
@Smeds
Copy link
Contributor Author

Smeds commented May 13, 2022

I find the variable name convert_file_input_to_dirs a bit confusing. Could we have something a bit simpler, like (e.g.) use_input_files_only, use_input_dirs, scan_input_dirs?

good suggestion! I have updated the pull-request with variable name use_input_files_only instead of convert_file_input_to_dirs

@Smeds Smeds requested a review from fgvieira May 13, 2022 14:00
@fgvieira
Copy link
Collaborator

I think it looks goos, but could you also describe this new parameter in the meta.yaml file?
Just so it is explained in the documentation.

Co-authored-by: Filipe G. Vieira <fgarrettvieira@gmail.com>
@Smeds Smeds requested a review from fgvieira May 16, 2022 08:40
@fgvieira fgvieira merged commit 32fd0e0 into snakemake:master May 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants