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

Specific output flags #70

Closed
dwysocki opened this issue Aug 24, 2015 · 2 comments
Closed

Specific output flags #70

dwysocki opened this issue Aug 24, 2015 · 2 comments
Labels

Comments

@dwysocki
Copy link
Member

There are currently two methods of data output in plotypus.

We write a table summarizing the results to stdout, which has gotten rather hairy. If the -o/--output flag is given, we output a plot for each input file, in much the same format as that input.

This approach does not scale very well. #66 asks for an option to output the residuals to a file. We also output fitted light curves in the stdout table, but it would probably make more sense to output them in the same format as they are input, for input to other programs. Multiple periods also gives us issues with output.

What I suggest we do is abolish the -o/--output flag, and replace it with --output-plots. Then we can add other flags in the same manner, such as --output-residuals (to address #66), --output-fits (and remove fits from the output table), etc.

I'm going to go ahead and say we're definitely going to implement this feature, and the only matter up for debate is the naming convention for the flags. Any suggestions over the current ones?

@dwysocki dwysocki added the tweak label Aug 24, 2015
@dwysocki
Copy link
Member Author

I'm now thinking that I prefer the naming convention --output-table-***** for tabular output, and --output-plot-***** for plot outputs. This allows us to have multiple kinds of plots, and an easy distinction between plot and data.

The existing -o/--output flag would therefore be replaced by --output-plot-lightcurve.

@dwysocki
Copy link
Member Author

As of #72, --output has been renamed to --output-plot-lightcurve. Future output flags should follow this format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant