History: r_test

• «
• »

            R_test intends to be an easy way of testing PluginR development ([http://dev.tikiwiki.org/PluginR]) on advanced usage, where a basic pretty tracker workflow is needed for users to upload a file with data to be processed, and an page with a program in R language has to process it and produce some output for that user. 

There are 4 sets of tests for the time being:
* __Test1__. Testing procedure to process csv file with data through an R  script in a wiki page, by means of submitting a new tracker item with that csv file as attachment.
* __Test2__. Testing many basic R commands with good and wrong syntaxes. some of them include Pretty Tracker display through .tpl file on disk as template.
* __Test3__. Testing the process of allowing the user to chose some params to be used in some simple R script. Uses a Pretty Tracker with template in a wiki page. 
* __Test4__. Testing security param.

To be done still: 
* __Test5__. Testing the process of allowing the user to edit some params of a graph produced by some simple R script. (using tracker prefill + pretty tracker, I guess...)

{maketoc}

These pages will be created:
~~lightgrey:''(listed properly only when shown here: http://profiles.tikiwiki.org/r_test , not when you are at profile installation in your remote tiki site)''~~
{TITLESEARCH(search="r_test",exclude="r_test",noheader="1")}{TITLESEARCH}

!! Trackers

{CODE(caption=>YAML,wrap=>1)}
preferences:
 feature_trackers: y
 feature_user_watches: y 
 feature_view_tpl: n
 feature_edit_templates: y
 feature_wiki_templates: y
 wikiplugin_r: y
instructions: r_test1
objects:
 -
  type: tracker
  ref: r_test_tracker1
  data:
   name: Datasets
   description: Files with data (like csv) to be processed by R scripts through tracker plugin calls
   default_status: open
   show: [ status, creation_date, modification_date, list_modification_date ]
   allow: [ comments, attachments ]
 -
  type: tracker_field
  ref: r_test_summary
  data:
   name: Summary
   tracker: $r_test_tracker1
   type: text_field
   flags: [ searchable, public, list, mandatory, link ]
   order: 10
 -
  type: tracker_field
  ref: r_test_description
  data:
   name: Description
   tracker: $r_test_tracker1
   type: text_area
   options: 1
   flags: [ public ]
   order: 20
 -
  type: tracker_field
  ref: r_test_from
  data:
   name: From user
   tracker: $r_test_tracker1
   type: user
   flags: [ searchable, public, list ]
   order: 30
 -
  type: tracker_field
  ref: r_test_attachment
  data:
   name: Dataset file
   tracker: $r_test_tracker1
   type: attachment
   flags: [ searchable, public, list ]
   order: 40
 -
  type: tracker_field
  ref: r_test_xmin
  data:
   name: Minimum value for axis X
   tracker: $r_test_tracker1
   type: text_field
   flags: [ searchable, public, list ]
   order: 50
 -
  type: tracker_field
  ref: r_test_xmax
  data:
   name: Maximum value for axis X
   tracker: $r_test_tracker1
   type: text_field
   flags: [ searchable, public, list ]
   order: 60
{CODE}

!! Groups & Permissions

{CODE(caption=>YAML, wrap=1)}
permissions:
 Anonymous:
  allow: view
  deny: [ ]
 Registered:
  description: Will be ignored because group is already created
  allow:
   - create_tracker_items
   - list_trackers
   - view_trackers
   - watch_trackers
  deny: [  ]
  objects:
   -
    type: wiki_page
    id: r_test3_template01
    allow: use_as_template
 Editors:
  description: Trusted users
  allow:
   - modify_tracker_items
   - trust_input
   - view_templates
   - edit_templates
   - use_content_templates
   - edit_content_templates
   - admin_content_templates
   - use_as_template
 Admins:
  description: Have all rights
  allow:
   - admin
   - trust_input
{CODE}

!! Users and group assignations

{CODE(caption=>YAML,wrap=>1)}
objects:
 -
  type: users
  data: 
    name: user
    pass: 1234
 -
  type: users
  data: 
    name: admin
    group: [ Editors ]
{CODE}

!! Sample data

{CODE(caption=>YAML,wrap=>1)}
objects:
 -
  type: tracker_item
  ref: dataset_001
  data:
   tracker: $r_test_tracker1
   status: open
   values:
    - [ $r_test_summary, Sample dataset ]
    - [ $r_test_from, admin ]
    - [ $r_test_description, "This dataset was created as part of the sample data for r_test." ]
    - [ $r_test_attachment, ]
    - [ $r_test_xmin, 1]
    - [ $r_test_xmax, 10]
 -
  type: tracker_item
  ref: dataset_002
  data:
   tracker: $r_test_tracker1
   status: pending
   values:
    - [ $r_test_summary, We are working on this dataset ]
    - [ $r_test_from, admin ]
    - [ $r_test_description, "This will soon be changed" ]
    - [ $r_test_attachment, ]
    - [ $r_test_xmin, 21]
    - [ $r_test_xmax, 30]
 -
  type: tracker_item
  ref: dataset_003
  data:
   tracker: $r_test_tracker1
   status: closed
   values:
    - [ $r_test_summary, A really old dataset ]
    - [ $r_test_from, admin ]
    - [ $r_test_description, "This dataset is outdated." ]
    - [ $r_test_attachment, ]
    - [ $r_test_xmin, 100]
    - [ $r_test_xmax, 110]

{CODE}

!! Modules
{CODE(caption=>YAML)}
objects:
 -
  type: module
  ref: module_last_modif_tracker_items
  data:
   name: last_modif_tracker_items
   groups: [ Anonymous, Registered ]
   position: right
   order: 5
   params:
    trackerId: $r_test_tracker1
    name: Summary
{CODE}


!! Wiki pages

{CODE(caption=>YAML)}
preferences:
  enable: [ feature_wiki ]
objects:
  -
    type: wiki_page
    ref:  r_test1_page
    data:
      name: r_test1
      description: Interface to send datasets
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test1
  -
    type: wiki_page
    ref:  r_test1_analysis_page
    data:
      name: r_test1_analysis
      description: Interface to show the results from the analysis
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test1_analysis
  -
    type: wiki_page
    ref:  r_test2_page
    data:
      name: r_test2
      description: Interface to test several things
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test2
  -
    type: wiki_page
    ref:  r_test2_template01_page
    data:
      name: r_test2_template01
      description: Template for smarty tpl on disk
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test2_template01
  -
    type: wiki_page
    ref:  r_test3_page
    data:
      name: r_test3
      description: Interface to change graph params and display png
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test3
  -
    type: wiki_page
    ref:  r_test3_template01_page
    data:
      name: r_test3_template01
      description: Template for wiki page
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test3_template01
  -
    type: wiki_page
    ref:  r_test4_page
    data:
      name: r_test4
      description: Interface to test security checks
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test4
{CODE}

!! Content Templates for pre-defined reports

{CODE(caption=>YAML,wrap="1")}
objects:
 -
  type: template
  ref: content_template_report_01
  data:
   name: Report 01
   content: wikicontent:Profile_r_test_ContentTemplate_Report_01
   sections: [ wiki page ]
{CODE}

!! Useful navigational aid
!!! Wiki Page for the Menu
This will add the page ((Profile_r_test_menupage)) as the menu content

{CODE(caption=>YAML,wrap="1")}
objects:
  -
    type: wiki_page
    ref: r_test_menupage_include
    data:
      name: Menu for R tests
      description: Collaborative simple menu
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_r_test_menupage
{CODE}

!!! Module wiki side menu
{CODE(caption=>YAML,wrap=>1)}
objects:
 -
  type: module
  ref: module_menupage
  data:
   name: menupage
   position: right
   groups: [ Anonymous, Registered ]
   order: 2
   params:
    pagemenu: Menu for R tests
{CODE}

!!! Extra features enabled for this wiki side menu 
Add smileys for an easy way to add icons for bullets in the wiki page menu, without making them too much on the right. 
{CODE(caption=>YAML,wrap="1")}
preferences:
 feature_smileys: y
 wikiplugin_img: y
 wikiplugin_div: y
 wikiplugin_listpages: y
 wikiplugin_titlesearch: y
 wikiplugininline_div: y
 wikiplugininline_img: y
 wikiplugininline_listpages: y
 wikiplugininline_titlesearch: y
{CODE}


-=Links=-
* [http://dev.tikiwiki.org/PluginR]
* [http://r-project.org]
* [http://mods.tikiwiki.org/details.php?type=wikiplugins&mod=r]