Skip to content

Commit

Permalink
ENH: Rebrand to QIIME 2
Browse files Browse the repository at this point in the history
Pair-programmed with @jairideout

Fizes #82
  • Loading branch information
thermokarst committed Feb 6, 2018
1 parent 58b3589 commit d63c01b
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 36 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Keemei website

Source for the Keemei website hosted at http://keemei.qiime.org.
Source for the Keemei website hosted at https://keemei.qiime2.org.

Powered by [Jekyll](http://jekyllrb.com/) using the [SinglePaged](https://github.com/t413/SinglePaged) theme by Tim O'Brien ([t413.com](http://t413.com/)). Icons powered by [Font-Awesome](http://fortawesome.github.io/Font-Awesome/). Favicon created with [Dynamic Drive's FavIcon Generator](http://tools.dynamicdrive.com/favicon/).

Keemei source code is located at https://github.com/biocore/Keemei.
Keemei source code is located at https://github.com/qiime2/Keemei.

To view website locally:

Expand Down
5 changes: 2 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ highlighter: rouge

### content configuration ###
title: "Keemei: Validate tabular bioinformatics file formats in Google Sheets"
keywords: "Keemei, tabular, bioinformatics, metadata, validation, validate, QIIME, qiime, Google Sheets, add-on, spreadsheet, file format"
description: "Keemei is an open source Google Sheets add-on for validating tabular bioinformatics file formats, including QIIME mapping files."
source_link: "https://github.com/biocore/Keemei"
description: "Keemei is an open source Google Sheets add-on for validating tabular bioinformatics file formats, including QIIME 2 metadata files."
source_link: "https://github.com/qiime2/Keemei"
favicon: "/favicon.ico"
touch_icon:
google_analytics_key: UA-38042047-2
Expand Down
15 changes: 10 additions & 5 deletions _posts/2000-01-01-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,26 @@ color: black

<div style="text-align:center">
<img width="250" height="250" src="img/keemei-logo.png" alt="Keemei logo" />
<a href="https://qiime2.org" target="_blank">
<img style="padding-left: 50px;" src="img/qiime2-logo.png" alt="QIIME 2 logo" /></a>
</div>
<p></p>

# {{ site.title }}

Keemei (canonically pronounced *key may*) is an open source [Google Sheets](http://www.google.com/sheets/about/) add-on for validating tabular bioinformatics file formats, including [QIIME](http://qiime.org/) mapping files.
Keemei (canonically pronounced *key may*) is an open source [Google Sheets](http://www.google.com/sheets/about/) add-on for validating tabular bioinformatics file formats, including [QIIME 2](https://qiime2.org/) metadata files.

Keemei supports validating QIIME [metadata mapping files](http://qiime.org/documentation/file_formats.html#metadata-mapping-files), providing validation similar to QIIME's [`validate_mapping_file.py`](http://qiime.org/scripts/validate_mapping_file.html) command-line script. QIIME's [`load_remote_mapping_file.py`](http://qiime.org/scripts/load_remote_mapping_file.html) script can be used to load Google Sheets that have been validated by Keemei (see [this](http://qiime.org/tutorials/remote_mapping_files.html) tutorial for details).
Keemei supports validating the following file formats:

Keemei also supports validating SRGD files (e.g., for use with geneGIS). For more information about SRGD files and geneGIS, visit [http://genegis.org](http://genegis.org).
- [QIIME 2 metadata files](https://docs.qiime2.org/2017.12/tutorials/metadata/)
- [QIIME 1 mapping files](http://qiime.org/documentation/file_formats.html#metadata-mapping-files)
- [Qiita sample information files](https://qiita.ucsd.edu/static/doc/html/tutorials/prepare-information-files.html)
- [SRGD files](http://genegis.org) (e.g., for use with geneGIS)

If you use Keemei for any published research, please include the following citation:

> **Keemei: cloud-based validation of tabular bioinformatics file formats in Google Sheets.**
> Rideout JR, Chase JH, Bolyen E, Ackermann G, González A, Knight R, Caporaso JG.
> **Keemei: cloud-based validation of tabular bioinformatics file formats in Google Sheets.**
> Rideout JR, Chase JH, Bolyen E, Ackermann G, González A, Knight R, Caporaso JG.
> GigaScience. 2016;5:27. [http://dx.doi.org/10.1186/s13742-016-0133-6](http://dx.doi.org/10.1186/s13742-016-0133-6)
Find the Keemei paper [here](http://dx.doi.org/10.1186/s13742-016-0133-6).
Expand Down
18 changes: 9 additions & 9 deletions _posts/2000-01-04-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ fa-icon: power-off

In this section you'll learn how to use Keemei to validate some example data. These data are derived from:

1. QIIME's [Illumina Overview Tutorial](http://qiime.org/tutorials/illumina_overview_tutorial.html) mapping file
1. "88 Soils" QIIME mapping file (Lauber et al., 2009)
1. QIIME 1's [Illumina Overview Tutorial](http://qiime.org/tutorials/illumina_overview_tutorial.html) mapping file
1. "88 Soils" QIIME 1 mapping file (Lauber et al., 2009)
1. geneGIS [example SRGD file](https://github.com/genegis/genegis/blob/master/Data/SRGD_example.csv)

These data are for **demonstration purposes only**. Errors have been intentionally introduced to illustrate validation with Keemei. **Do not use these data for analysis.**
Expand All @@ -29,10 +29,10 @@ You now have a copy of the example data to validate with Keemei.

### Validating your data

First we'll see how to validate a QIIME mapping file with Keemei.
First we'll see how to validate a QIIME 1 mapping file with Keemei.

1. Make *QIIME Illumina Overview Tutorial* the active sheet if it isn't already.
1. Validate this sheet by clicking `Add-ons > Keemei > Validate QIIME mapping file`:
1. Make *QIIME 1 Illumina Overview Tutorial* the active sheet if it isn't already.
1. Validate this sheet by clicking `Add-ons > Keemei > Validate QIIME 1 mapping file`:

![Validate active sheet](img/validate-active-sheet.png)

Expand All @@ -48,7 +48,7 @@ First we'll see how to validate a QIIME mapping file with Keemei.

![Cell hover](img/cell-hover.png)

1. Make fixes to any number of invalid cells and re-validate by clicking `Add-ons > Keemei > Validate QIIME mapping file`. Repeat this process until all cells are valid.
1. Make fixes to any number of invalid cells and re-validate by clicking `Add-ons > Keemei > Validate QIIME 1 mapping file`. Repeat this process until all cells are valid.

-------------------------

Expand All @@ -64,8 +64,8 @@ First we'll see how to validate a QIIME mapping file with Keemei.

Keemei's sidebar provides a way to focus on an invalid cell in order to fix it. This feature is especially useful if you're working with large sheets that would require scrolling to find and fix invalid cells.

1. Make *QIIME 88 Soils* the active sheet.
1. Validate this sheet by clicking `Add-ons > Keemei > Validate QIIME mapping file`.
1. Make *QIIME 1 88 Soils* the active sheet.
1. Validate this sheet by clicking `Add-ons > Keemei > Validate QIIME 1 mapping file`.
1. The two invalid cells (O46 and O66) are not visible in the sheet. Click the magnifying glass next to cell O46...

![Cell focus 1](img/cell-focus-1.png)
Expand All @@ -80,6 +80,6 @@ Keemei's sidebar provides a way to focus on an invalid cell in order to fix it.

### Validating SRGD files

In the previous sections we validated QIIME mapping files. Keemei also supports validating SRGD files by clicking `Add-ons > Keemei > Validate SRGD file`. Validation results are displayed in a similar manner.
In the previous sections we validated QIIME 1 mapping files. Keemei also supports validating SRGD files by clicking `Add-ons > Keemei > Validate SRGD file`. Validation results are displayed in a similar manner.

Make *SRGD_example* the active sheet and try validating it as an SRGD file. How many invalid cells are there?
14 changes: 1 addition & 13 deletions _posts/2000-01-05-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,7 @@ fa-icon: question-circle

## How do I get help with using Keemei?

To report an issue with Keemei or ask a question, click `Add-ons > Keemei > Help` and then click `Report an issue`:

<div style="text-align:center">
<img src="img/report-issue.png" alt="Report an issue" />
</div>
<p></p>

Be sure to select the option to provide your name and email address if you would like a Keemei developer to follow up with you:

<div style="text-align:center">
<img src="img/report-issue-follow-up.png" alt="Include name and email address when reporting an issue" />
</div>
<p></p>
To report an issue with Keemei or ask a question, please post to the [QIIME 2 Forum](https://forum.qiime2.org).

## FAQs

Expand Down
8 changes: 4 additions & 4 deletions _posts/2000-01-06-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ When you run Keemei for the first time, you will be prompted to authorize Keemei
- Keemei displays validation status by modifying cell background colors and notes in the currently active Google Sheet. Keemei will only access data in the current Google Sheet that it is executed on. Keemei will never create or delete Google Sheets in your Google Drive.
- Permission Scope: *Display and run third-party web content in prompts and sidebars inside Google applications*
- Keemei builds and displays a validation report in a sidebar, which is rendered in your browser using HTML, Javascript, and CSS.

Keemei does not store or share Google user data. Keemei uses [Google Analytics](https://analytics.google.com) to track add-on and website usage statistics.

Please direct all inquiries about this Privacy Policy to [https://forum.qiime2.org](https://forum.qiime2.org).

## Credits

Keemei was developed by Jai Ram Rideout ([@jairideout](https://github.com/jairideout)) in the [Caporaso Lab](http://caporasolab.us). See the full list of Keemei's contributors [here](https://github.com/biocore/Keemei/graphs/contributors). Keemei's logo was created by John Chase ([@johnchase](https://github.com/johnchase)).
Keemei is a [QIIME 2](https://qiime2.org) project developed by the [Caporaso Lab](http://caporasolab.us). See the full list of Keemei's contributors [on GitHub](https://github.com/qiime2/Keemei/graphs/contributors). Keemei was originally developed by Jai Ram Rideout ([@jairideout](https://github.com/jairideout)) in the [Caporaso Lab](http://caporasolab.us). Keemei's logo was created by John Chase ([@johnchase](https://github.com/johnchase)).

## Licensing

Keemei is available under the new BSD license. See [here](https://github.com/biocore/Keemei/blob/master/LICENSE) for Keemei's license.
Keemei is available under the new BSD license. See [here](https://github.com/qiime2/Keemei/blob/master/LICENSE) for Keemei's license.

Keemei uses and distributes [Moment.js](http://momentjs.com/), available under the MIT license. See [here](https://github.com/biocore/Keemei/blob/master/licenses/Moment.js.txt) for Moment.js' license.
Keemei uses and distributes [Moment.js](http://momentjs.com/), available under the MIT license. See [here](https://github.com/qiime2/Keemei/blob/master/licenses/Moment.js.txt) for Moment.js' license.
Binary file removed img/report-issue-follow-up.png
Binary file not shown.
Binary file removed img/report-issue.png
Binary file not shown.

0 comments on commit d63c01b

Please sign in to comment.