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

Rename ATDF writer to Text writer #4

Merged
merged 2 commits into from Dec 16, 2017
Merged

Conversation

minhhaiphys
Copy link
Contributor

The AtdfWriter function and stdf2atdf script convert STDF to its text representation, not exactly in ATDF format (which has somewhat different specs from STDF). To avoid misunderstanding, I propose to rename them to TextWriter and stdf2text respectively.

One more minor change to allow users to convert STDF to a text file, instead of parsing all the text to the screen.

minhhaiphys and others added 2 commits December 15, 2017 13:51
Rename AtdfWriter to TextWriter, stdf2atdf script to stdf2text.

Allow users to write text into a file instead of parsing onto the screen.
In line with recent commit of renaming stdf2atdf to stdf2text command.
@cmars
Copy link
Owner

cmars commented Dec 15, 2017

If AtdfWriter isn't producing valid ATDF anyway... would a CSV format be more generally useful than pipe-delimited?

@minhhaiphys
Copy link
Contributor Author

Since arrays are converted to comma delimited, CSV for the entire STDF would cause difficulty for user to load CSV to other analysis tools such as Excel. So pipe delimited would be the easiest. Alternatives can be semicolon, colon. Another option is giving user the choice by adding a kwarg such as delimiter='|'

I do have functions to import STDF into list of text/dictionary/DataFrame object and script to export to Excel, which I use for analysis. If you're interested in having those into the master, I'll create another merge request.

@cmars
Copy link
Owner

cmars commented Dec 16, 2017

I do have functions to import STDF into list of text/dictionary/DataFrame object and script to export to Excel, which I use for analysis. If you're interested in having those into the master, I'll create another merge request.

That'd be most welcome, thanks!

@cmars cmars merged commit c374f81 into cmars:master Dec 16, 2017
@cmars
Copy link
Owner

cmars commented Dec 16, 2017

The delimiter kwarg would be a nice followup.

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