QuantiModo-WordPress-Plugin ======================================= [![Codacy Badge](https://api.codacy.com/project/badge/9267e17136a34184905cec32f8867d32)](https://www.codacy.com/app/m_3/QuantiModo-WordPress-Plugin) [![Code Climate](https://codeclimate.com/github/Abolitionist-Project/QuantiModo-WordPress-Plugin/badges/gpa.svg)](https://codeclimate.com/github/Abolitionist-Project/QuantiModo-WordPress-Plugin) *The roadmap for the development of the plugin is below. We'd be very grateful for any pull requests. Thanks!* Help ignite a revolution of citizen science to find new solutions to chronic illnesses. Install the Quantimodo Wordpress plugin! This is a mobile-friendly WordPress plugin that enables users of any WordPress to authenticate and share their data from QuantiModo.com. It also allows you to embed dynamic graphs containing your users' Quantified Self data agggregated at QuantiModo.com. These graphs may be included in any page or post using shortcode. Note: This JavaScript library (https://github.com/QuantiModo/QuantiModo-SDK-JavaScript/blob/master/quantimodo-api.js) is required for this plugin's functionality. ## Add QuantiModo Login Button PURPOSE: The purpose of allowing users to log in via the QuantiModo API's OAuth2 endpoint is so that the WordPress site can obtain an OAuth2 access token which will be included in the Authorization header of all API requests to QuantiModo as a Bearer token. It is in this way that the user may authorize the QM API to obtain their data from other API's such as Fitbit, MyFitnessPal, Withings, etc. This is done using the Connect shortcode. Once a user has authorized QuantiModo to obtain their data, the WordPress site can use the OAuth2 access token to also make API requests to the QM API in order to store new user supplied data or visualize their data on various graphs produced by the Timeline and Predictors shortcode. SETUP: - Download and install the QuantiModo-WordPress-Plugin. - Create a new app in the [QuantiModo Developer Portal](https://app.quantimo.do/api/v2/apps) to get an API client id and secret. - Add your QM API key/secret in the WordPress backend under Settings > QuantiModo. - Add the QM Login button anywhere to your site with the [qmoa_login_form] shortcode. Once a user authorizes you to access their measurements, their OAuth access tokens will be stored and refreshed automatically. They will be able to continue to access their data through your site until they revoke access. *Possible shortcode attributes:* - layout - determines whether to display the login buttons as links or buttons, stacked vertically or lined up horizontally. Possible values: links-row, links-column, buttons-row, buttons-column - align - sets the horizontal alignment of the custom form elements. Possible values: left, middle, right - show_login - determines when the login buttons will be shown. Possible values: never, conditional, always - show_logout - determines when the logout button will be shown. Possible values: never, conditional, always - logged_out_title - sets the text to display above the custom login form when the user is logged out. Possible values: any text - logged_in_title - sets the text to display above the custom login form when the user is logged in. Possible values: any text - logging_in_title - sets the text to display above the custom login form when the user is logging ing. Possible values: any text - logging_out_title - sets the text to display above the custom login form when the user is logging out. Possible values: any text - style - sets the custom css style to apply to the custom login form. Possible values: any text - class - sets the custom css class to apply to the custom login form. Possible values: any text For example: [qmoa_login_form layout="buttons-column" align="left"] ## Timeline Graph Shortcode - [qmwp_timeline] To see how it works: - Create an account at https://quantimo.do - Connect the Weather connector at https://quantimo.do/connect/ (using "62034" as your zip code if you're not on Earth and you don't have a location to enter.) - Go to https://quantimo.do/analyze and select a variable to chart on the left. If you have any problems with this process, please submit a help request by clicking the "Feedback" tab on the right. The code to be used for this shortcode is here: https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/timeline-page ![](https://i.imgur.com/AwhxdGP.png) ## Correlation Charts Shortcode - [qm_correlation_charts] This shortcode would allow one to create a widget or shortcode for embedding a Highcharts longitudinal timeline, correlation scatterplot, or correlation listing bar graph in posts, pages, custom post types, and sidebars. Variables, settings, and filters are supplied when creating a the widget or shortcode. The charts would also include a the ability to add or remove variables. To see how it works: - Create an account at https://quantimo.do - Connect the Weather connector at https://quantimo.do/connect/ (using "62034" as your zip code if you're not on Earth and you don't have a location to enter.) - Go to https://quantimo.do/correlate and select a variable to chart on the left. If you have any problems with this process, please submit a help request by clicking the "Feedback" tab on the right. The code to be used for this shortcode is here: https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/correlation_charts ![correlations-page-demo-sleep-mood-1024x648](https://cloud.githubusercontent.com/assets/2808553/10770971/25b5c1d4-7cbc-11e5-90d5-5c046cb70d89.png) *Possible shortcode attributes for correlation charts:* - examined_variable - Sets the default examined variable. Possible values: any variable name - secondary_variable - Sets the default secondary variable to be selected on the bar graph. Possible values: any variable name - examined_is_cause - Sets the examined variable to be considered the cause in the relationship. Possible values: true or false. Default: false ## Import Data Shortcode - [qmwp_manage_accounts] To see how it works: - Create an account at https://quantimo.do - Connect the Weather connector at https://quantimo.do/connect (using "62034" as your zip code if you're not on Earth and you don't have a location to enter.) ![quantimodo manage connected accounts - google chrome 10152014 63216 pm](https://cloud.githubusercontent.com/assets/2808553/8172734/39b6f640-1389-11e5-9d1c-332d4e5a7c54.jpg) The code for this page is located here: https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/connect-page ## Add a Measurement Button Shortcode - [qm_add_measurement] This would create an "Add a Measurement" button which produces a popup similar to the the QuantiModo Chrome extension that allows a user to submit a measurement. How to Record a Measurement 1. CLICK THE EXTENSION - Click the QuantiModo icon in the upper right hand side of your browser. It might be hidden. In that case you'll have to drag the divider line to the right of the URL field to see it. 2. SELECT A VARIABLE - Type the name of the variable that you want to track. If it's an existing variable, the settings should be populated automatically and you can move to step 3. If you've never entered data for that variable before you'll need to adjust the settings for that variable first 3. ADD YOUR MEASUREMENT - Then enter the value for the measurement and select the correct units. 4. SEND YOUR MEASUREMENT - After pressing the "ADD" button data is then sent to https://app.quantimo.do/. Demo: Try https://chrome.google.com/webstore/detail/quantimodo-universal-trac/jioloifallegdkgjklafkkbniianjbgi?hl=en-US The relevant code and more information on the functionality can be found at https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/QM-Search-Plugin ## Correlation Search Box Shortcode - [qm_correlation_search] Demo: https://quantimo.do/qm-search This plugin creates a new WordPress page that allows one to search for: - The strongest predictors of the severity of any given condition - The most strongly predicted effects of any given stimulus The results are based on the average predictive correlations for all QuantiModo users. - The user should indicate if they want to search for the effects of - The user should type in characters - and have an autocomplete drop down with the top 5 variables with the highest correlations If the entered variable "Crazy Ass Variable No One Ever Heard Of" doesn't exist: ``` Your search - Crazy Ass Variable No One Ever Heard Of - did not match any documents. Suggestions: Make sure all words are spelled correctly. Try different keywords. Try more general keywords. ``` *Possible shortcode attributes for correlation search:* - searched-cause-variable - Instead of a search box, only a list of the effects of this variable are displayed - searched-effect-variable - Instead of a search box, only a list of the causes of this variable are displayed ![what-affects-qm-search-box-screenshot-2014-06-29-20 14_picmonkeyed](https://cloud.githubusercontent.com/assets/2808553/8192570/adcca18c-1434-11e5-8ba4-1c415f363394.png) ![search-results-page-mockup png](https://cloud.githubusercontent.com/assets/2808553/8192587/d66be102-1434-11e5-9082-fa47a69a108b.jpg) The code and more information can be found at https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/QM-Search-Plugin ### What still needs to be done for the Correlation Search shortcode to be complete - API requests should include Bearer access tokens from `wp_usermeta` table in the Authorization header of all API requests. - If user receives a "Not Authenticated" response from the API, the QuantiModo OAuth login dialog should popup or user should be redirected there and redirect back after logging in and authorizing access. - Refresh tokens should be obtained and stored when necessary - Code from WP custom template needs to be made available for embed as a shortcode with options specified above ## Mood Tracker Shortcode - [qmwp_rating_faces] This would create a widget/shortcode with the mood-rating faces that we could put in a page/post or sidebar. If clicked on, it would submit an overall mood measurement for the currently logged in user. Demo: https://chrome.google.com/webstore/detail/moodimodo-beta/lncgjbhijecjdbdgeigfodmiimpmlelg?hl=en-US We want to be able to embed those faces in any WP page or post. Here's the code for the Chrome extension to use as a resource: https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/MoodiModo-Chrome ![mood-rating-wordpress-shortcode](https://cloud.githubusercontent.com/assets/2808553/8238887/10787330-15be-11e5-853c-93f00d8e45cd.png) # Options for Adding Shortcode Shortcode can be added to a post through "Add Media" by installing [ShortCake](https://github.com/fusioneng/Shortcake). Our API documentation can be found at https://quantimo.do/api/docs/index.html # Planned Features ## QuantiModo Studies Plugin This plugin could be used to automatically create studies using the "Study" custom post type by selecting one or more variables. This custom post type would be located in the QuantiModo custom WP dashboard menu. A WordPress plugin to allow citizen scientists to share their discoveries. This plugin could be used to automatically create studies using the "Study" custom post by selecting one or more variables. The study post would display: - Title: Question to be answered by the study. - Conclusion: Answer the question through interpretation of results. - Hypothetical Cause: - Hypothetical Effect: - Principal Investigator: Person who created the study. - Background: Reason for the study and/or existing research on topic. Results: - Scatterplot with hypothetical effect on y axis and hypothetical cause on x-axis; - Parameters of analysis (variable settings); - Data download option; - Timeline graph (optional) - Methods: List of apps and devices used to obtain the measurements. - Limitations (Optional): Include with any reservations like potentially confouding variables, sampling error, etc - Suggestions for further research. Walkthrough of User Actions: - Creates a Study custom post. - Enters a research question like "What affects my mood?" in the title of the post - Enters some text description of the study in the post body content - Selects an "Examined Variable" - Selects "What is predictive of EXAMINED VARIABLE?" or "What does EXAMINED VARIABLE predict?" - User presses publish. - Study posts are listed on a WP Page Called Studies - User click on their study title and excerpt in the Studies page. - User is taken to a Study post - Study post contains the Research Question (Title) at the top - User study post body content is below the title - Bar graph containing "Secondary Variable" correlations with the Examined Variable is below the post body content text. - If user clicks on a Secondary Variable in the bar graph, a scatterplot and timeline chart pop up Here's the initial code for this feature: https://github.com/QuantiModo/QuantiModo-WordPress-Plugin/tree/develop/reference/QuantiModo-Personal-Studies-Plugin Preliminary Mockup for Back End of Study custom post type: ![heroku_wplms_create_studies](https://cloud.githubusercontent.com/assets/2808553/8193448/81f8b202-143a-11e5-9137-d47c5b2ae1ce.png) Preliminary Mockup for front end of Study custom post type: ![qm-study-custom-post-type-front-end-template](https://cloud.githubusercontent.com/assets/2808553/8193426/5eaff8f0-143a-11e5-9a08-76f3d5538e5f.png) # Testing ## PHPUnit tests We recommend the use of a pre-configured virtualized environment, like [Varying Vagrant Vagrants](https://github.com/Varying-Vagrant-Vagrants/VVV) (VVV), as it provides a consistent environment for developing, testing, troubleshooting and debugging your code. VVV includes WP-CLI and PHPUnit which make unit testing that much easier. If you're using VVV you can skip step 1. 1. Install WP-CLI and PHPUnit 2. Initialize the unit tests using WP-CLI. In a terminal, navigate to the root of the WordPress instance and run `wp scaffold plugin-tests plugin-name` replacing plugin-name with the name of the plugin. So for the Widgets Bundle you would run `wp scaffold plugin-tests so-widgets-bundle`. 3. Navigate to the root of the plugin directory. `cd wp-content/plugins/so-widgets-bundle` 4. Run `bash bin/install-wp-tests.sh wordpress_test db_user db_password localhost latest`, replacing `db_user` and `db_pass` with your database user's username and password and `localhost` with your database hostname. 5. That's it! Now you can run PHPUnit and you should see the output of the unit tests. ## Selenium UI tests 1. Download and install Node.js and npm. 2. In a terminal, navigate to the root of the plugin directory and run `npm install` 3. Get some coffee while npm installs the required packages. 4. That's it! Now you can run `npm test ./selenium-tests` and you should see a Chrome browser window open and the Selenium UI tests run. QuantiPress =========== Other shortcodes: ### Data Import **Tracker** - Any application or device capable of quantifying some aspect of human life. This plugin should: 1. Create a single "Trackers" WP PAGE where icons for all connectors and uploaders are displayed in categories (see https://quantimo.do/tools/ or https://www.dropbox.com/s/ke032k91j2m8c5k/Screenshot%202014-07-15%2000.39.25.png). - Create a "QuantiModo" top-level WP administration menu see (ask Zain for example link and screenshot). - Create a "Trackers" sub-level WP administration menu within the "QuantiModo" top-level WP administration menu. - Create a "Tracker" custom post type. See this example of the front end appearance https://quantimo.do/portfolio/fitbit-2/ or https://www.dropbox.com/s/z61ncgo7gmyxsmf/Screenshot%202014-07-15%2001.05.13.png. See this example of the back end appearance - Create a "Tracker" custom post (like for each record in the `quantimodo`.`sources` database. - shortcodes for each connector icon to be displayed. - Specific connectors could be added as shortcodes or widgets to any page. - Any connectors could be added on the individual tools pages. - This would create a page and page template for the connectors page. ### Predictor Search This plugin would add a search box widget and a qm-search and qm-search-results templates. The search box would be similar to the Google search. The search results page template would have a list of variables preditive of or predicted by the searched variable in order of correlation. This page would also display the average values predictive of an above or below average effect. ### Universal Tracker This would create a widget similar to the the QuantiModo Chrome extension that allows a user to submit a measurement. ### MoodiModo This would create a widget/shortcode with the mood-rating faces that we could put in a page/post or sidebar. If clicked on, it would submit an overall mood measurement for the currently logged in user. ### Visualization This allow one to create a widget or shortcode for embedding a Highcharts longitudinal timeline, correlation scatterplot, or correlation listing bar graph in posts, pages, custom post types, and sidebars. Variables, settings, and filters are supplied when creating a the widget or shortcode. The charts would also include a the ability to add or remove variables. Example for inserting into posts: - http://wordpress.org/plugins/shortcodes-ultimate - http://wordpress.org/plugins/wp-slimstat-shortcodes/ ### Variable Settings This would create a pop-up This would be a pop-up window, widget, and page template that could be called from other widgets. Could be embedded using shortcode. Requirements: QuantiModo API Plugin. Example: http://wordpress.org/plugins/advanced-custom-fields/ ### Studies This plugin could be used to automatically create studies using the "Study" custom post type by selecting one or more variables. This custom post type would be located in the QuantiModo custom WP dashboard menu.  Example: http://wordpress.org/plugins/wp-slimstat-shortcodes/ ## WHY To abolish all uneccessary suffering on earth. ## HOW Accelerate research by integrate, analyze, and visualize life tracking data to find out what most impacts health and happiness. Then, share your discoveries with other citizen scientists!