Skip to content

Commit 5c0a009

Browse files
author
Julie Imig
committed
updating tutorials
1 parent e87eae9 commit 5c0a009

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

TUTORIAL/tutorial_readme.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,16 @@ mct check_filenames mct-tutorial --directory='tutorial-data/' --exclude='*_spec
164164
```
165165
The output message will report that this command only checked 2 files, but both files passed.
166166

167+
### Step 4e. Exporting results to alternate format
168+
169+
If you're not used to working with SQLite `.db` files, you can also save the output to an alternate format using the `--output_format` flag. Currently supported values include "csv", "fits", "html", and "excel".
170+
171+
For example, this command will save out a html file with the filename checker results in a color-coded table:
172+
173+
```shell
174+
mct check_filenames mct-tutorial --directory='tutorial-data/' --output_format='html'
175+
```
176+
167177

168178
# Additional Resources
169179
Congratulations! You have completed this tutorial and now know the basic usage of the MAST Contributor's Tools Filename Checker.

docs/filename_check_readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The various options for this command are described below:
2222
| `-e` or `--exclude` | File pattern to exclude from testing, for example '*.jpg' to test all files except the jpgs | None |
2323
| `-n` or `--max_n` | Maximum number of files to check, for testing purposes. | None (all files) |
2424
| `-db` or `--dbFile` | Name of Results database file | `results_<hlsp_name>.db` |
25+
| `-f` or `--output_format` | Write output to alternate format. Currently supports "csv", "fits", "html" or "excel" | `db` |
2526
| `-v` or `--verbose` | Enables verbose output for more information | `False` |
2627
| `--help` | Prints information about this command | |
2728

0 commit comments

Comments
 (0)