diff README.rst @ 0:ce4f91831680 draft default tip

planemo upload for repository https://github.com/Yating-L/suite_gonramp_apollo.git commit 5367a00befb467f162d1870edb91f9face72e894
author yating-l
date Fri, 16 Feb 2018 10:57:13 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Fri Feb 16 10:57:13 2018 -0500
@@ -0,0 +1,64 @@
+G-OnRamp Apollo Tools
+=====================
+
+A suite of Galaxy tools for managing a local Apollo server. It includes following tools:
+
+JBrowseHub to Apollo
+--------------------
+
+This Galaxy tool is used to create or overwrite an organism on an Apollo server with a jbrowse hub created by JBrowse Archive Creator. 
+
+Apollo User Manager
+-------------------
+
+This Galaxy tool is used to manage Apollo users. The currently supported operation including:
+
+  - Create a new user 
+  - Delete a user
+  - Add a user to a group (If the group doesn't exist, create the group)
+  - Remove a user to a group
+
+The tool can do these operations on one student at a time. It can also do the operations on multiple students at a time by uploading a text file, which including students information.
+
+The text file can be either CSV (comma-delimited) or Tabular (tab-delimited). It should have a header line, including names for each column. Example text files: 
+
+Text file for creating multiple users:
+
+.. csv-table:: 
+   :header: "useremail", "firstname", "lastname", "password"
+   :widths: 20, 10, 10, 10
+
+   "test1@demo.com", "test1", "demo", "1234"
+   "test2@demo.com", "test2", "demo", "1234"
+   "test3@demo.com", "test3", "demo", "1234"
+
+
+Text file for deleting multiple users:
+
+.. csv-table:: 
+    :header: "useremail"
+    :widths: 20
+
+    "test1@demo.com"
+    "test2@demo.com"
+    "test3@demo.com"
+
+Text file for adding multiple users to a group:
+
+.. csv-table:: 
+    :header: "useremail", "group"
+    :widths: 20, 20
+
+    "test1@demo.com", "Test group"
+    "test2@demo.com", "Test group"
+    "test3@demo.com", "Test group"
+
+Text file for removing multiple users to a group:
+
+.. csv-table:: 
+    :header: "useremail", "group"
+    :widths: 20, 20
+
+    "test1@demo.com", "Test group"
+    "test2@demo.com", "Test group"
+    "test3@demo.com", "Test group"