[Userscript] Wanikani Item Inspector

Requirements:

[ General Script Installation instructions ] :point_left: You’ll need a script host plugin like TamperMonkey
[ Open Framework Installation ]
[ Open Framework Additional Filters Installation ]

Download the script here:

Description

Wanikani Item Inspector displays information about Wanikani radicals, kanjis and vocabulary items in tabular form. Data about items are queried with filters to create the table. You may select which information goes in the table as well as the sort order. Once the table is obtained it can be inspected, studied and exported.

Four tables are supplied by default. More tables may be configured by the user.

  • Leeches: Displays your leeches. This table is suitable for studying your leeches…
  • Failed Last Review: Items that have failed their last review in the past 24 hours. Like Leeches this table is suitable for studying.
  • Current Level SRS: Contains SRS information for items of your current level. The popup contains the scheduled review time. Useful to track when radicals and kanji will go to Guru.
  • Previous Level SRS: Like the previous table but for items of the previous level. Useful to track when the last remaining kanjis not yet gurued of the previous level will go to Guru and unlock vocabulary.

Tables may be used for the following purposes:

  • Studying Items You may go over the items reciting meanings and readings, and then you move the mouse over the item to reveal the anser in a pop up. A click on the item opens the Wanikani item page where mnemonics, synonyms and other information is available.
  • Studying Leeches A leech is an item that gives you trouble during reviews. It is called a leech because it siphons your energy by clogging your review pile. The leech table lists the leeches in order of leech values which is a measure of how much trouble the item gives you.
  • Understanding Your Items The information revealed may be used for many purposes. For instance it may be used to plan a reset.
  • English to Japanese Studies It is possible to display the items by their English meaning. Then the studying may go in the other direction, from English to Japanese.
  • Exporting to csv Format These exports may be used by spreadsheet and other software such as anki.
  • Exporting Items to Plain Text This information may be used by word processor software.
  • Word Clouds It is possible to repeat exported words according to some metrics. This can be used in word cloud software to produce word clouds.

Tables

The Table View

Item Inspector displays tables like this.

Table

These tables are designed to support studying. You may go over the items one by one and recite the meanings and readings. Then you move the mouse over the item to reveal the actual meaning and reading in a popup. If you have business with the mnemonics and/or the synonyms you click on the item and the item page is displayed.

popup

As you may see the popup displays information besides the meaning and reading. This information is configurable. A lot of information available through the Wanikani API is accessible through the tables.

The kanji in the tables are small. They may be hard to read. This is why a larger version is available in popups. For purpose of studying it is desirable to be able to consult this enlarged version without revealing the reading and meaning, also located in the popup. A second popup located to the right of the item is available for this purpose.

popup

This popup may be annoying in tables that are not used for studying. It may be disabled in a setting. By default only the Leech table and the Failed Last Review have it. It is turned off on all other tables including newly created tables.

It is possible to turn on audio mode. Then when you click on a vocabulary item the audio is played. Turning off audio mode brings back the click to open the item page. Audio is not available for kanji and radicals.

It is possible to display items by their English meanings instead of the Japanese characters.

Table

Item Inspector tables are designed to fit on one screen so you don’t have to scroll to read the items. However the number of lines that fit your screen depends on the theme you are using. It is possible to configure the number of lines to fit your screen with a setting.

The Icon List View

It is also possible to present the items as a list of icons.

The information that was presented in table form is now shown in markers. All items following a marker share the same information, until the next market informs us of a change of value.

No marker is present for information that changes every item like meaning, reading etc. This information is in the popup.

marker

Like tables, list of icons are suitable for studying. Information is revealed in a popup when the mouse moves over.

popup

Clicking on an icon opens the item page. In audio mode vocabulary icons play audio.

It is possible to display English meaning in icons.

English

The Control Bar

The title bar features widgets. If there are more items than there is room to display them you may navigate over your items using the forward and backward buttons on the left hand side… A dropdown lets you select the table to display.

Other buttons of interest are:

toggle1 Toggles between table view and list of icons view.

There is the toggle between Japanese and English mode for the display of items. This button changes icon depending on the current state.
toggle2 English mode is on. Click to change to Japanese.
toggle3 Japanese mode is on. Click to change to English.

There is the toggle between link to new page and audio mode for the click on vocabulary items. This button changes icon depending on the current state.
toggle4 Link mode is on. Click to change to audio.
toggle5 Audio mode is on. Click to change to link.

The there is a pair of buttons for export.
export1 Export table data to csv format.
export2 Export word list to plain text.

Last are two utilities button.
setting Opens the settings dialog.
helpa Opens this page for easy access to documentation.

Settings for tables

The settings features a widget for managing your tables. You may add, delete, reorder or rename your tables. You may also select a table to edit its specific settings.

TableList

The Filters tab lets you control the filters that are used to select the items in the table. Each filter is controlled by a checkbox. If checked the filter is applicable and you may set the filter parameter. All selected filters will be applied and the resulting items will be displayed on the table.

Filters

The Contents tab lets you select which information is displayed in the table and in the popup. You may also specify the sort order. The setting for showing the enlarged item is located there.

Random Selection Feature

When the filtering settings return a large number of items it is useful to limit the table to a smaller more manageable size. The random selection setting permit to limit the size of the table to a set value. A setting of 0 disable this feature. A value greater than zero returns a random selection of the stated number of items. Multiple displays of the table will return a different selection each time. This may be used for things like selecting 30 random burned items for a cram review.

Random

Effect on SRS

Some of you may worry of the effect of extra studying on the learning value of SRS. If you see the meaning and reading of an item too close of the review time it may influence the result of the review in a way that doesn’t reflect how you are learning the item. The solution is to configure the Time Until Review filter. It will exclude from the table items that are close to the review time. By default this filter is not configured.

Leeches

Leech Values

The leech table relies on a formula that calculates a leech value. This formula captures how much trouble an item is giving you. If the leech value is an integer then most often you just have failed a review. In this case the leech value is the number of incorrect answers since the item has been unlocked. When the leech value is a real number you are ongoing a streak of correct answers. The leech value will gradually decrease

Math Geek Note

The leech formula:is:

LeechValue = IncorrectCount / currentStreak1.5

The higher the value the more troublesome the item is. If you have many reviews incorrect the numerator will increase. The more often you are incorrect the higher the leech value will get. On the other hand if you are on a roll and have a streak of successful reviews the denominator will increase. The longer the streak the lower the leech value will be. If you fail a review your streak will stop and the leech value will revert to a high number.

Wanikani statistics used in the leech formula start counting streaks at 1. When you just have failed a review the streak is 1, not 0. Moreover the calculation is done separately for meanings and readings. The largest of the two numbers is the leech value.

The best parameter for the leech filter is 1. All items with a leech value greater or equal to 1 will be displayed. This will include all items that have failed a review for the first time because these items always have a leech value of 1. If you feel you should exclude these items use 1.01 for the filter parameter. Values lower than 1 will return items that are not troublesome and should not be used. Another useful value is 2. This number ensures an item is considered a leech only when you have failed it at least twice. It is also more selective as what is a leech than 1.01.

The leech value formula has an unfortunate feature. If you fail too many reviews you can’t get a long enough streak to bring the leech value back under the filter threshold before the item is burned. The solution is to supplement the leech filter with the SRS Level filter. Items that reaches Enlightened and Burned are dropped off the table under the assumption that if you can drive an item this far it is not troublesome enough to be a leech. This filter is configured by default.

There is also the Leech Streak Limit setting that causes a leech to be dropped of the table when the current streak of correct answers reaches a certain number. By default this setting is turned off.

Leech

A Tip for Those Who Consider a Reset

If you consider resetting because you have too many items poorly learned you can use Item Inspector to better plan your reset. Set the Table Data Element to Level in the Leech table. This will cause your leeches to be displayed in order of levels. You will be able to see which levels have a lot of leeches and which do not cause particular problems. You will then be able to pinpoint the best level to reset to.

Exporting Features

Copy Lists of Items to Clipboard and Word Cloud Support

The following button copies the items in the current table into you clipboard. You may then paste them in the software of your choice. The items will be listed in the same order as they appear in the table. This copies just the items and not any other data in the table.

clipboard

There are also settings that go with this:

image

Some radicals have no unicode characters to represent them. They are displayed as images in the tables. These images can’t be exported. These items are exported as latins characters, for example the cleat radical is exported as ‘cleat’. For some applications like word clouds this may ruin the look. You have the option to exclude these radicals from the export.

You also have the option of exporting items one by line or all bundled in a single paragraph.

You may set a limit to the number of exported items. Some tables are large and you may want just the first x items. If the limit is 0 then the whole table will be exported.

There is also support for the making of word clouds. item Inspector does not make word clouds but it you copy the items in the clipboard you may then paste them in you word cloud making software. This requires to repeat the item according to a numeric value, otherwise you end up with an equal weight word cloud. This setting permits to choose which value will be used to repeat.

wordcloud

Export Items Data to CSV Format to Clipboard - Supporting Transfer to Spreadsheet Software

The following button exports the table data to the clipboard in csv format.

export

Once in the clipboard you may access the data as follow:

  • You may paste it in a text processor like Windows notepad. Then the file may be saved with a .csv extension for use with any software supporting the csv format.
  • You may paste it directly in a spreadsheet software. Most such software can impost csv from the clipboard. A dialog such as this one will likely appear. It can vary according to the software. This one is from Libre Office)

You must use this dialogue to instruct you spreadsheet software on how the csv file is formatted. You need to supply this information.

  • You must use delimiters (“the separated” by option).
  • The delimiter is a comma.
  • String delimiters are double quotes "
  • Formatted fields must not by formatted as text.

Without this information the csv data will not be properly imported by the spreadsheet software.

Tables must be configured for exporting prior to export. This is done in the Export tab of the page settings. There you indicate whether you want a title line for the columns and which information belongs to which column.

Procedure for Tracking the Evolution of Leeches with a Spreadsheet Using Exported Data

This is a step by step procedure using Libre Office. This is the software I have so I use it for the demonstration It is up to you to adapt the procedure to the software you use.

To track leeches you need to configure the Leech table export information as this:

  • The Level and Export Date columns are required to sort the spreadsheet. They are best placed at the beginning because they provide context to the leech data.
  • Item and Item Type are both necessary to identify the items. Some items are visually identical and can be distinguished only by their types. (Rad. Kan. Voc.)
  • The Leech Value tracks the status of the leech.
  • The other three columns provide additional information that tracks how the leech healing process is going.

Exports must be done periodically to take snapshots of your leech situation. The data will be pasted cumulatively in one spreadsheet. The procedure is as follows.

  • For the first export include a title for you columns. Then export the data in an empty spreadsheet.
  • For subsequent export turn off the title line. You already have one. You paste the new data at the end of your existing data. To do so select the first empty cell of the first column and paste. The information will nicely position after your existing data.

paste

You also need to make a separate csv file using notepad or similar software for each download. You can paste multiple times the same data as long as you don’t overwrite the clipboard. Your spreadsheet will grow big overtime and become unwieldy. When that happens start a new spreadsheet by pasting the data from some of your most recent csv. This will in effect eliminate older stale data without too much labor.

After a download you need to sort the data to make it useful. Use the sorting function in the menu that pops up the sort wizard.

Sort

The in the wizard configure the four sort columns as follows.

  • First sort column Level order ascending.
  • Second sort column Item order ascending.
  • Third sort column Type order ascending
  • Fourth column Export Date order ascending

This will place the items nicely ordered for inspection. Lines with the same item and type will be one after another ordered by Export date. Then you can highlight the most recent export with conditional formatting.

  • Select the Export Date column.
  • Enter the conditional formatting dialog for dates.

Conditional

Use a style with bold and yellow background. Set it to the dates in the last seven days.

Conditional

This will cause the date of your most recent export to become yellow and bold.

  • You can tell right away which line corresponds to your last export and compare the leech situation with the history given by the lines right above it.
  • You can tell when a new leech appears because there is no lines for preceding history.
  • You can tell when an item is no longer a leech because there is no highlighted date for this item.

Miscellaneous

Release History

Version 1.7.2 - Bug fix
Version 1.7.1 - Bug fix
Version 1.7.0 - List of icons, meaning mode and audio support.
Version 1.6.1 - Bug fix.
Version 1.6.0 - Adding support for the Breeze Dark theme.
Version 1.5.1 - Bug fixes
Version 1.5.0 - Export of table data to csv.
Version 1.4.2 - Look and ease of use improvements. See here
Version 1.4.1 - Repeat for word cloud feature added
Version 1.4.0 - Item export to clipboard. See here
Version 1.3.4 - New features. See here
Version 1.3.3 - Bug fix
Version 1.3.2 - Implements Table State Memory
Version 1.3.1 - Bug fix
Version 1.3.0 - New features. See here
Version 1.2.1 - Fixed a deprecated API attribute, minor bug fixes.
Version 1.2.0 - New features. See here
Version 1.1.1 - Minor bugfix.
Version 1.1 - Bug fixes and improvements. See here.
Version 1.0 - Original release

Acknowledgements

Thanks to Dani2 whose code has helped jumpstart this project.

Big thanks to @rfindley for putting the Self Study Script under the MIT licence, which authorizes me to use this code in Item Inspector.

Thanks to @Kumirei for showing me how to implement the dashboard position feature. Also thanks for permitting to use code from Dashboard Apprentice in Item Inspector.

A special note to @seanblue: The Self-Study Quiz is no longer the sole user of the Open Framework Additional Filters script.

18 Likes

Only here because I saw the term “Inspector”
:eyes:
:grimacing:
:laughing:
I kid of course. I am going to try this out once I get back from work tonight! Thank you for your efforts.
:nerd_face::steam_locomotive:

2 Likes

Version 1.1 of Item Inspector is now released.

The changes:

  • A few bug fixes.

  • The title bar is changed from 'Top Items" to 'Items". No effort is made to select top items so it is simply items now.

  • In the settings the number of tooltip elements is increased from three to four.

  • In the settings new choices for data are added to the dropdown.

Dropdown

  • The hours format is now a setting. The old “Review Date 12h” and “Review Date 24h” options are now replaced by simply “Review Date”.

  • The sort format is improved with a secondary key to sort items with the same primary key when it makes sense to do so. For example items with the same SRS Level are sorted by Review Date within a SRS Level.

Update your script with Tampermonkey “Check for userscript updates” feature.

Update

If you install Item Inspector for the first time please use the procedure at the beginning of the top post.

1 Like

I like the idea with the tooltips which I missed in the old leech table script.
However there seem to be some problems:

  • I still get V1.0 out of greasyfork
  • I set the WK level as third tooltip to be displayed and since then I only get radicals with leech level 0:

My settings are (no filters set):

My fault. I hadn’t installed the Open Framework Additional Filters. Now it’s working again - but there still is no V1.1 as announced?

I updated the link in the top post. Now you should get V 1.1.

1 Like

Got it. Merci beaucoup!

Version 1.1.1 is now available. This is a minor bugfix.

You may download it here:

https://greasyfork.org/fr/scripts/406308-wanikani-item-inspector

If you download Item Inspector for the first time make sure to comply with the requirements mentioned in the top post.

I swapped it out and so far I’m really happy with it. It looks boss.

1 Like

Thanks for your kind words. I am glad that you are happy.

1 Like

Version 1.2.0 of Item Inspector is released.
This is a new features version.

New data element for tables and tooltips “Lesson Date”:

LessonDate

Now available: sorting options for those who don’t like the default sorting order.

Sort

Now available: a random selection feature:

Random

A value of zero disable the random selection and returns all items. A value greater than zero returns a random selection of the stated number of items. Multiple displays of the table will return a different selection each time. This may be used for things like selecting 30 random burned items for a cram review.

You may download version 1.2.0 here:

https://greasyfork.org/fr/scripts/406404-wanikani-item-inspector

If you Install Item Inspector for the first time make sure to meet the requirements mentioned at the beginning of the top post.

@adr-p: You are waiting for the sort option. It is here. I think you want to sort by Lesson Date.

1 Like

Thank you! Much appreciated!

1 Like

Version 1.2.1 is now released.

  • Replaced a deprecated Wanikani API attribute with a supported attribute.
  • Minor bug fixes.

You can have it here.

https://greasyfork.org/fr/scripts/406404-wanikani-item-inspector

If you install Item Inspector for the first time make sure you comply with the requirements mentioned at the beginning of the top post.

1 Like

Per our conversation, I was finally able to install your creation.
image
Thanks to you, it seems I have a LOT of leeches
:sweat_smile:

1 Like

I suggest you use the Random Selection feature to bring the number to a manageable study size.

1 Like

I tweaked the settings (followed your 1.01 tip) and it fell to 473. It’s still a lot so I have work to do :sweat_smile:

simple request

The only thing I would like to ask is how to make it’s location on my page lower. I prefer to have this below the heatmap and the leaderboard if possible.

Thanks.

Other people (me for example) prefer to have it higher. It is difficult to get below Heatmap and Leaderboard. These scripts position themselves at the very bottom of the page. Someone has to give in.

Ah I see. I will make a personal adjustment instead. Thank you for creating a very useful script!
:bowing_man: :nerd_face: :slightly_smiling_face:

1 Like

Hello!
Where exactly do I set the 1.01 filter value? It’s not in settings on the website, so I suppose it’s in the script itself, but there’re so many filters that I’m not sure which one is needed. Right now it shows me the items even with 0, even though I guess it wasn’t supposed to?

If it displays items with 0 the most probable cause is the Leech Training parameter has been set to 0.

Here is where you go to the proper setting. First you must open the Settings dialog like this.

Next you go to the Tables tab and make sure the Leech table is selected. Otherwise you will set the setting for some other table.

Tables

Finally you go to the Filters tab and change the Leech Training parameter.

Leech

1 Like