Workflow @biodavidjm

[biodavidjm]

• Extend full description of the Stock-Import project. This implies:
  • [ ] Understand scope and current stay of the project.
  • [ ] Identify and list remaining tasks.
  • [ ] List of software engineering principles needed to learn.

Issues Execute modware-import throws:

• Deprecation warning solved in #17
• An error analyzed in #18

[cybersiddhu]

Please cross reference all of your issues here. This is the one i need to review.

[cybersiddhu]

I would break down the project in following way. Remember they need to finished serially and should not be skipped. Every project tends to have the following traits. So, finish one by one.

Project structure

This is kind of implicit, however to help you i am trying to be explicit.

• Reason you are doing this project, means why doing this project is relevant. If this is not very clear or you are not convinced with the reasoning, the project cannot continue, and stop right there. Escalate the problem to first to me or if not satisfactory to the PI.
• Scope of the project, means what need to be done and what already been done.
• List of action items means the steps that you actually have to do. For example,
  • Write code.
  • Learn software concept.
  • Learn database concept.

This is the meat of the project, in fact in every project.

• Deliverables means timeline means how long it will take. You could do this clearly only if you define the previous step. Put time one that you are comfortable with you.
• Constraints means anything or any issue that could block the finish of the project. This could be for example ...
  • Dependence of another software or project which is not finished or not working expectedly.
  • Unexpected issues with the software you are running.

Review

Meet at least once in a week to discuss any problem involve in any one of the above step. The things you define first when you start are going to change always, so we need to update our goals as software project tends to be agile and iterative a lot of the time. For urgent problem please ask right away.

Use the above as guideline to spend some time to structure your project.

[cybersiddhu]

Scope

• The export process is completed. However, the scripts have to be run to prepare exports.
• Majority of the import of is completed. So, only the leftover pieces have to recognized.
• Write software to import the leftover pieces.
• Data model design is finished. The data model could be changed if it is required to import the leftover pieces, but considered that to be only in emergency situation. All effort should be taken not to make any major changes in data model.

Work breakdown structure

Graphical representation of work breakdown. Each module is a unit of work presented in a directed acyclic graph(DAG). Some unit of work depends on other to be finished, some could be done in parallel. The black circle indicate expected amount of time taken for each piece. d: days h: hours m: minutes There should be a deliverables(expected outcome) for each piece which should be completed. And some of pieces also have some milestones. Add documentation if only needed to understand any concept, otherwise it is not necessary. Make sure everything gets linked from this page.

[cybersiddhu]

Work progress

The most important section. The list is not sequential so look at the graph and pick up as necessary. Add an issue for any piece that requires more work. If anything requires more than a week(5 days) of work that requires further breakdown.

Guidelines

If the module has milestone link, please go to that page and check what would the outcome(deliverables). Finish the deliverables, that marks the completion of the module. Most of them should come with some form of code repository. Do not tick it unless you have the outcome finished. Provide a link of the outcome.

• [x] Understand relational database concepts.
  • Deliverables: Able to understand the database, schema, tables, columns.
• [x] Learn how to do CRUD with database.
  • Deliverables:
  • Able to create a database, schema, tables and columns.
  • Should understand index, constraints and foreign keys.
  • Should be able to do insert, update, delete rows in the tables.
  • Should be able to alter a table structure.
  • Done. I created my own PostgreSQL music database from my iTunes music collection. Check this folder to review all the sql files, perl scripts, and the source xml file
• [x] Learn working with DBI --- Here
• [x] Learn OOP with Perl.
  • Deliverables: Here
• [x] Learn writing unit testing with Perl.
  • Deliverables: Unit tests for the libraries written for module Learn OOP with Perl.
• [ ] Learn working with DBIx::Class.
  • Deliverables: Here
• [ ] Learn unit testing with database backend.
  • Deliverables: Here
• [ ] Understand stock module in chado schema.
  • Deliverables:
  • Should be able to understand all basic relational database concept for this chado schema.
• [x] Install chado schema.
• [ ] Understand dictybase data model in chado schema.
  • Deliverables:
  • Should able to explain which data goes to which table.
  • Able to explain the relationship between data and tables.
  • Able to write SQL statement to perform CRUD operations. Present all SQL statements for doing all CRUD operations.
  • Provide a graphical representation of data model in the chado stock schema.

[cybersiddhu]

• [x] Setup Perl developmental environment.
  • Deliverables:
  • Install perlbrew/plenv to manage multiple perl versions other than system one.
  • Should be able to use local::lib module to manage project specific dependencies.
  • Should be integrated with the command line shell environment.

David: Done. Follow this link with the document explaining how it is done.

• [x] Install Modware::Loader.
  • Deliverables
  • Should be able to install Modware::Loader using cpanm.
  • Should be able to manipulate perl library location for a custom install using cpanm.
  • Should be able to resolve broken install.
  • Should be able to install a particular version of module using cpanm.
• [x] Run export scripts.
• [x] Run existing import scripts.
• [ ] Figure out what was left from importing.
  • Deliverables:
  • Should be able to explain what data types are left from importing.
  • Develop a written or visual plan for importing that data type.
• [ ] Learn how to write command line application in perl.
  • Deliverables:
  • Convert all scripts written in previous modules(OOP and DBIx::Class) to command line applications.
  • Unit tests for all command line modules.
• [ ] Write command line application to import leftover data.
  • Deliverables: Here