| Excerpt |
|---|
See step-by-step instructions for running an HTRC algorithm. |
Run a text analysis algorithm
...
Make sure you are logged in to HTRC Analytics. Navigate to the algorithms by clicking "Algorithms" on Run algorithms on the menu bar on the top part of page.
On the Algorithms Run algorithms page, select an algorithm from the list. You can read the description to learn about what the algorithms can do on your workset. For this example we chose the "Meandre_Topic_ModelingToken Count and Tag Cloud Creator" algorithm. Click “Execute” to use this algorithm.
Fill in the required parameters. Some parameters have optional default values while for some others you will need to fill them in. You will also need to select a workset (i.e. a collection) that you want to work with. Below shows the parameters entered for this demo. Click on the "Submit" button to submit the job.
After submitting, you will be taken to the Jobs "Algorithm results" page for viewing job status. You can stay on the Jobs "Algorithm results" page and refresh the page to see the most up-to-date status of the job. Depending on how fast the job is computed, you will probably see the job listed in the "Active Jobs" section. You can also see all the active jobs submitted by you.
Examine results of algorithm
During and after submitting a text analysis job, you can see what your work on the "JobsAlgorithm results" page.
After the job is finished, you can see the job is listed in the "Completed Jobsresults" section. Click on the job name to see its result.
This is also the page you will come to to see your results in the future. To get here again, click the Jobs "Algorithm results" button from the Algorithm "Run algorithms" page. (Note that you must be signed in to access these options.)
If you want to view past jobs, you can filter the results by name.
To view results, click on the job name.
On this job result page, I can use the tabs to see outputs of running the topic modeling tag cloud algorithm. This algorithm displays the top words in my workset as a tag cloud (tagcloudcleantokencounts.html), in a list (tagcouldcleantokencounts.csv.txt), and logs (stdout.txt and stderrorstderr.txt).
Download a workset
After you have created a workset, you can download it as a list of volume identifiers in comma separated value (csv) format. Because each workset is functionally a list of pointers to content in the HathiTrust Digital Library, the full text of the volumes is not included in the download. If you are interested in receiving a dataset from the HathiTrust to do research on your own machine, please refer to the directions for requesting a custom dataset. The volume identifiers in a workset are consistent with the volume identifiers used elsewhere across the HathiTrust.
From the homepage of HTRC Analytics sign in and then navigate to Worksets.
Click on the name of the workset you would like to download and click the "Download" button.
