ctmm-initiative / ctmmweb

Web app for analyzing animal tracking data, built upon ctmm R package
http://biology.umd.edu/movement.html
GNU General Public License v3.0
30 stars 21 forks source link

Add a Start page to the sidebar #118

Closed jmcalabrese closed 4 years ago

jmcalabrese commented 4 years ago

With the addition of the analysis guide feature, the top two boxes on the "Import" page now have nothing to do with data import. I'm wondering if we should add a "Start" page before "Import" that contains these two boxes, and provides room for any other app config/settings or user guidance/help features we may add in the future?

chfleming commented 4 years ago

Or we could change the name of the "Import" page to "Start"?

xhdong-umd commented 4 years ago

I think change page name is simpler as we don't have enough content for a complete new page. In the future if we need it we can extract them.

xhdong-umd commented 4 years ago

First page renamed to "Start".

jmcalabrese commented 4 years ago

I'm fine with this as a short term measure, but think that there should be separate start and import pages longer term. One addition to a pure start page that I could see happening in the near future is a box that contains direct links to ctmmweb (and possibly also ctmm) vignettes.

xhdong-umd commented 4 years ago

We can put links in help button window without taking more space, though that is not directly visible.

jmcalabrese commented 4 years ago

If vignettes are buried in the help system, lots of users won't find them. The point of the start page idea is to make user aides and config stuff more visible, without muddling the core content of the import page.

Beyond adding an entry in the sidebar, is there any actual cost to adding a separate start page?

xhdong-umd commented 4 years ago

There is no cost and it's easy to adjust. Just I'm not sure if the first page will be too sparse with less contents.

xhdong-umd commented 4 years ago

If adding a start page, I think it cannot be named as "start". When we define the workflow pages, start page should not be part of main steps. Maybe we can name it as "Introduction"?

xhdong-umd commented 4 years ago

I added an intro page, put some vignette links in it. I also made the icons of menu slightly brighter, otherwise it looks too dim. image

xhdong-umd commented 4 years ago

I also updated the windows installer with R 3.6.3, using newer version of inno setup.

jmcalabrese commented 4 years ago

@xhdong-umd Thanks! I see your reasoning for calling it intro instead of start, and will think it over. I agree that the intro/start page shouldn't be part of the main workflow or analysis guide.

I think we should add a help button to the vignettes box, with an explanation that vignettes are a work in progress, and that, eventually, there will be more beginner friendly ctmmweb vignettes.

jmcalabrese commented 4 years ago

@xhdong-umd Below is edited text for the vignette help box:

xhdong-umd commented 4 years ago

Master and cloud updated with this and the fix of Speed/Distance guide.

jmcalabrese commented 4 years ago

One last little thing...I suggest removing the "Periodic movement models" vignette from the vignette box, as it is not really relevant to ctmmweb.

xhdong-umd commented 4 years ago

Updated master and cloud for this.