Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update manual and README (and sample files) #18

Open
codaich opened this issue Oct 5, 2016 · 1 comment
Open

Update manual and README (and sample files) #18

codaich opened this issue Oct 5, 2016 · 1 comment
Assignees

Comments

@codaich
Copy link
Collaborator

codaich commented Oct 5, 2016

  • Update all relevant references from jSymbolic to jSymbolic2
  • Note that command line extraction of a directory now automatically extracts features from symbolic files in sub-directories as well
  • Add MEI assumptions made by jMei2Midi
  • Include sample graphs of melodic interval histogram, vertical interval histograms, wrapped vertical interval histogram, chord type histograms and all the instrument histograms.
  • Add 2016 CIRMMT presentation content and images
    • As well as any other relevant publications
  • Add section on how to use extracted features with ACE, Weka and Excel
  • Update Class Structure section of the manual
  • Update Version History section of the manual
    • Will need to update new feature numbers already added, based on numbering changes, and add new features as well.
  • Substantially rewrite README
    • Include an explicit link to the manual (in the file structure and on Sourceforge)
  • Do complete read-through to make sure all changes are documented
@codaich codaich self-assigned this Oct 5, 2016
@codaich codaich changed the title Update manual and README Update manual and README (and sample files) Oct 6, 2016
@codaich
Copy link
Collaborator Author

codaich commented Oct 6, 2016

Also include in distribution (and refer to in manual and README):

  • Sample configuration files
    • Include a default config file called "jSymbolicDefaultConfigs.txt" in same directory as the jSymbolic.jar file with the distribution
    • Config files for only extracting 1-D features
    • Config files for extracting all features
    • Config files for specifying and not specifying input and output files
  • Test MIDI and MEI files
  • Sample output files
  • Sample run transcriptions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant