SpeciesFileGroup / taxonworks_doc

TaxonWorks (https://taxonworks.org) documentation.
https://docs.taxonworks.org
13 stars 13 forks source link

Importing to TaxonWorks #30

Open mjy opened 3 years ago

mjy commented 3 years ago

in progress

Importing to TaxonWorks

This is version 0.0.1. All changes beyond grammar will result in an increment. Higher level increments reflect larger changes that may reflect new ways of doing things, or differences in user interfaces, etc.

You can ask for help and clarification live in person on Gitter!

Overview

This manual overviews the ways that data can be batch/bulk/en-masse imported into TaxonWorks.

Exercise target audience

Curators adding significant quantities of data. For "scientific" purposes "significant" means, more or less, "it would take a trained user more than 4 hours to do this piecemeal", or I have > 500 records.

Exercise goals

The goals are to describe:

At the end of the exercise you should:

Assumptions

Gotchas

Tips

Related exercises

Exercise

Syntax

Import types

Model based "Batch load" options

Major format batch loaders

DwC-Archive
BibTeX

Coding your own batch-loader

Rake tasks

Ruby's "make" language is called Rake that creates "tasks' (not to be confused with TaxonWorks' "Task" interfaces cards).. Using Rake you have full access to the full TaxonWorks environment. You can setup your own repository, point to the TaxonWorks Rails environment, and code away. While we are moving these tasks out of the core code base, you can see some of them here.

A New Task

Technically you can contribute a whole new interface and underlying model for importing your data, this can be as customized as you wish if you have the chops!

Section title 2

...

Section title 3

...

Wrapping up

Reminder of what was taught/learned.

Addendum

Addendum topic 1