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

more clear explanation about splitCsv() operators #4163

Merged
merged 4 commits into from
Sep 3, 2023

Conversation

dxu104
Copy link
Contributor

@dxu104 dxu104 commented Aug 9, 2023

From the provided official documentation, I noticed that the description of how the .splitCsv() operation handles CSV data and the nature of its returned data structures is somewhat ambiguous. The documentation showcases examples with and without the header parameter, but it doesn't explicitly mention the exact type of returned data (List vsLinkedHashMap).

I believe that such clarity would be invaluable to readers aiming to understand the .splitCsv() operation fully. For the sake of clarity and comprehensiveness in the documentation, I propose the following clarifications:

**- If the header option is not used, .splitCsv() returns each row as a List.

  • If header: true is used, or if a list of strings is provided for the header, then .splitCsv() returns each row as a LinkedHashMap**

Incorporating this information into the official documentation would offer readers a more lucid and actionable understanding.

@netlify
Copy link

netlify bot commented Aug 9, 2023

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 77919a4
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/64f47d856adf830007a3f56b
😎 Deploy Preview https://deploy-preview-4163--nextflow-docs-staging.netlify.app/operator
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bentsherman
Copy link
Member

Fwiw I think I have done this in #3959

@dxu104
Copy link
Contributor Author

dxu104 commented Aug 9, 2023

Thank you for your mention. But I did not find your pull request related with mine. Do you think my pr can be merge

@pditommaso pditommaso force-pushed the master branch 2 times, most recently from 81f7cb7 to 8a43489 Compare August 20, 2023 20:13
docs/operator.md Outdated Show resolved Hide resolved
Signed-off-by: Paolo Di Tommaso <[email protected]>
@pditommaso pditommaso merged commit 1dfb621 into nextflow-io:master Sep 3, 2023
@pditommaso pditommaso added this to the 23.10.0 milestone Sep 10, 2023
abhi18av pushed a commit to abhi18av/nextflow that referenced this pull request Oct 28, 2023


Signed-off-by: Jesse <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Paolo Di Tommaso <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants