Add sensible default values to outfile

[mirca]

work in progress to address #64

[codecov]

Codecov Report

Merging #68 into master will decrease coverage by 0.03%.
The diff coverage is 24.06%.

@@            Coverage Diff             @@
##           master      #68      +/-   ##
==========================================
- Coverage   13.57%   13.53%   -0.04%     
==========================================
  Files          49       49              
  Lines        9322     9397      +75     
==========================================
+ Hits         1265     1272       +7     
- Misses       8057     8125      +68

Impacted Files	Coverage Δ
pyke/kepio.py	25.27% <0%> (ø)	⬆️
pyke/kepdetrend.py	6.59% <10%> (+0.03%)	⬆️
pyke/kepprfphot.py	2.57% <10%> (-0.02%)	⬇️
pyke/tests/test_kepconvert.py	100% <100%> (ø)	⬆️
pyke/kepfilter.py	6.15% <12.5%> (-0.15%)	⬇️
pyke/keprange.py	7.81% <12.5%> (-0.07%)	⬇️
pyke/keptrim.py	6.87% <14.28%> (-0.12%)	⬇️
pyke/kepprf.py	5.39% <14.28%> (-0.04%)	⬇️
pyke/kepsff.py	2.59% <14.28%> (-0.03%)	⬇️
pyke/kephead.py	14.54% <14.28%> (-0.84%)	⬇️
... and 21 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b8be1d2...2cad12b. Read the comment docs.

[barentsen]

We are going to have to update the quickstart and the three tutorials as well.

[mirca]

@barentsen @gully I appreciate any input here. Updating quickstart and tutorials now...

[barentsen]

Looks good! My only (very minor) comment right now is that it would be nice to mention the default output name or suffix in the --help docstring.

[mirca]

@barentsen regarding the default output file name; how about this:

➜ kepbls --help
usage: kepbls [-h] [--outfile OUTFILE] [--datacol DATACOL] [--errcol ERRCOL]
              [--minper MINPER] [--maxper MAXPER] [--mindur MINDUR]
              [--maxdur MAXDUR] [--nsearch NSEARCH] [--nbins NBINS] [--plot]
              [--overwrite] [--verbose] [--logfile LOGFILE]
              infile

Perform Box-Least Square searches for periodic exoplanet transits

positional arguments:
  infile                Name of input file

optional arguments:
  -h, --help            show this help message and exit
  --outfile OUTFILE     Name of FITS file to output.If None, outfile is a
                        combination of infile andthe name of the pyke task.
                        (default: None)
  --datacol DATACOL     Name of data column to plot (default: DETSAP_FLUX)
  --errcol ERRCOL       Name of data error column to plot (default:
                        DETSAP_FLUX_ERR)
  --minper MINPER       Minimum search period [days] (default: 1.0)
  --maxper MAXPER       Maximum search period [days] (default: 30.0)
  --mindur MINDUR       Minimum transit duration [hours] (default: 0.5)
  --maxdur MAXDUR       Maximum transit duration [hours] (default: 12.0)
  --nsearch NSEARCH     Number of test periods between minper and maxper
                        (default: 1000)
  --nbins NBINS         Number of bins in the folded time series at any test
                        period (default: 1000)
  --plot                Plot result?
  --overwrite           Overwrite output file?
  --verbose             Write to a log file?
  --logfile LOGFILE, -l LOGFILE
                        Name of ascii log file (default: kepbls.log)

[barentsen]

I would perhaps change
If None, outfile is a combination of infile and the name of the pyke task.
into
By default, the output filename will be the same as the input filename with suffix "-kepbls.fits" added.

[barentsen]

I think this looks good. In the quickstart/tutorials we may want to use --outfile so that the tutorial can use simple descriptive filenames, but we can merge this now and review the clarity of the tutorials separately.