Closed bebatut closed 8 years ago
Hi,
With the french community, we proposed some checklists to develop wrappers and integrate them in a ToolShed.
General things before toolShedization:
tools
packages
planemo
pip install planemo
planemo config_init
~/.planemo.yml
Wrapper creation for a tool:
tool_name.xml
planemo tool_init --id 'tool_name' --name 'Tool description'
tool_dependencies.xml
requirements
test-data
tests
tool-data
data_name.loc.sample
tool_data_table_conf.xml.sample
.loc.sample
planemo lint
planemo test --galaxy_root=/path/to/galaxy
planemo serve --galaxy_root=/path/to/galaxy
ToolShedization of a tool or dependency package not for IUC GitHub repository:
planemo shed_init --name=<name> --owner=<shed_username> --description=<short description>
.shed.yml
planemo shed_lint
planemo shed_create --shed_target shed_name
planemo shed_update --shed_target
ToolShedization of a tool or dependency package for a IUC GitHub repository:
git clone tools-iuc name_of_repository_you_want
git checkout -b name_of_tool_to_develop
git commit
git push origin name_of_tool_to_develop
What do you think of these checklists ? Could they be integrated somewhere?
Yes! Awesome. I'll work on getting those into a PR form later this week. Thanks @bebatut :)
Hi,
With the french community, we proposed some checklists to develop wrappers and integrate them in a ToolShed.
General things before toolShedization:
tools
directory for the tools.packages
directory for the packagesplanemo
withpip install planemo
planemo config_init
and editing the~/.planemo.yml
fileWrapper creation for a tool:
tool_name.xml
file withplanemo tool_init --id 'tool_name' --name 'Tool description'
tool_name.xml
by checking the Best Practicestool_dependencies.xml
filerequirements
section intool_name.xml
with link topackages
intool_dependencies.xml
test-data
directorytest-data
directory with at least one input file and the expected output filetests
section intool_name.xml
filetool-data
directorydata_name.loc.sample
file intool-data
directory with description of the datatool_data_table_conf.xml.sample
file with link to.loc.sample
files intool-data
directorytool_name.xml
withplanemo lint
planemo test --galaxy_root=/path/to/galaxy
planemo serve --galaxy_root=/path/to/galaxy
ToolShedization of a tool or dependency package not for IUC GitHub repository:
planemo shed_init --name=<name> --owner=<shed_username> --description=<short description>
.shed.yml
file.shed.yml
file withplanemo shed_lint
planemo shed_create --shed_target shed_name
planemo shed_update --shed_target
ToolShedization of a tool or dependency package for a IUC GitHub repository:
git clone tools-iuc name_of_repository_you_want
git checkout -b name_of_tool_to_develop
tool_dependencies.xml
for package, check ToolShedization of a tool for more detail)git commit
git push origin name_of_tool_to_develop
What do you think of these checklists ? Could they be integrated somewhere?