FAQ

General:

• What is the r4st project?

  • The r4st ("Our Forest") project is a set of tools to assist with the rapid development of a database application. It uses shell scripts to drop/add Postgresql database tables/views with data loaded from sql and csv files. This process allows users to apply changes then re-build the system. It is essentially a customizable database regression system. The base schema and data module represent a plant database intended for educational and scientific usage.

• Why did you create this project?

  • I conduct aspen tree breeding and needed a robust and reliable record keeping system. I started tracking with spreadsheets but they didn't scale and certain reports are best served via SQL (vs a pivot table). The r4st system is more portable since it can store all of the data and be posted online for easy access. I often access my data in the field from my cell phone - very handy!

• Who could benefit from this project

  • The r4st project could benefit IT students interested in learning Linux and SQL. It could also interest scientists/students looking for a customizable plant database.

• What skills are needed to use r4st?

  • Developers interested in modifying the r4st process should have Unix command line, shell and SQL experience. However, once the r4st system is setup then most users should be able to view the data via the web interface and export csv data as needed.

• How does the r4st process work?

  • The r4st directory (aka "module") contains all of the shell, SQL and data files (.csv) that build the related database tables and views. Each build of the r4st process will drop all database objects then re-load them from the SQL scripts. The database tables are fully populated with data loaded from the .csv files that correspond to each table. A developer can make any SQL or data change and the system will report any errors after the build.

• What is the r4st-liveCD

  • The r4st module depends upon several prerequisites have been installed and configured including the Postgresql database, a unix shell environment, and a database front end tool. This project distributes a Xubuntu livecd remix, "r4st-liveCD" .iso file that is pre-configured with the r4st application and its dependencies. This allows a user to boot the CD and run the r4st application without any configuration.

• What are the r4st-liveCD Features

  • Four pre-configured Postgresql databases for each environment: r4d, r4t, r4s, r4p
  • The dbkiss database front end administration tool.
  • The phppgadmin database front end administration tool.
  • The Gnumeric spreadsheet.
  • The dmcsveditor to edit CSV files.

• What are the r4st-aspen module features

  • Data based on an aspen tree breeding project.
  • Designed to be viewed at the table level to reduce the need for a complex frontend application.
  • Table views and reports
  • Pedigree listing all filial parents.
  • Journal table linked to key tables for journal entries.

• Why isn't the r4st-aspen module data completely normalized?

  • The r4st-aspen data is intended to be viewed at the table level via a front end application like dbkiss. This keeps it simple without the overhead of building/maintaining a CRUD Application. The downside to this approach is some data duplication.

• Could others contribute their custom modules?

  • Yes, I hope others will contribute custom modules. I hope to review them and add them to the repository as appropriate.

HowTo:

• How do you use the r4st program (UC-1)
  • Burn the r4st-liveCD.iso to a cdrom and boot it up on a computer.
  • Or, load the .iso onto a virtual machine (e.g. VirtualBox)
  • Open a terminal window and enter "alias" at the command line to view the available aliases.
  • Enter the r4c alias command to to push a copy of the r4st-aspen module to the Desktop.
  • Enter the rf alias to execute the r4st program. No errors should display.
  • View/edit the r4st database via the PHP applications below:
    • http://localhost/phppgadmin (See shortcut on Desktop)
    • http://localhost/dbkiss.php (See shortcut on Desktop)
    • Username: xubuntu
    • Password: tux
  • From the Desktop, navigate to other r4st artifacts:
    • r4st-aspen/sql contains the SQL scripts (alias: sql).
    • r4st-aspen/csv contains the csv files (alias: csv).
    • r4st-aspen/docs contains the documentation (alias: docs).
    • r4st-aspen/bin contains the r4st executable (alias: bin).
  • Update r4st and test the changes:
    • Update an sql or csv file.
    • Run the r4st application via the rf alias.
    • If the update(s) were valid there should be no errors displayed.
    • If the update(s) were not valid error(s) should display. For more details view the log file, r4st-aspen/bin/r4st.log
  • View/Edit a csv file:
    • Enter the ec alias command to edit a .csv file (via dmcsveditor).
    • You can also add csv file-name argument (e.g. eg plant.csv).