annotate openalex.xml @ 0:1678b5f97915 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
author iuc
date Sat, 31 May 2025 12:25:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
1 <tool id="openalex_explorer" name="OpenAlex explorer" version="0.1.0+galaxy0" profile="23.1">
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
2 <description>Fetch citing papers from OpenAlex using DOI, openAlex ID, or title</description>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
3 <requirements>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
4 <requirement type="package" version="3.10">python</requirement>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
5 <requirement type="package" version="2.31.0">requests</requirement>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
6 </requirements>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
8 python3 '$__tool_directory__/openalex_fetch.py'
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
9 $input_type '$identifier'
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
10 --max-citations '$max_citations'
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
11 $download_pdfs
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
12 ]]></command>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
13 <inputs>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
14 <param name="input_type" type="select" label="Input type" help="Select whether the identifier is an OpenAlex ID, DOI, or Title">
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
15 <option value="--doi" selected="true">DOI</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
16 <option value="--id">OpenAlex ID</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
17 <option value="--title">Title</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
18 </param>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
19 <param name="identifier" type="text" label="Identifier" help="Enter the OpenAlex ID, DOI, or Title depending on your selection above"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
20 <param name="download_pdfs" type="boolean" truevalue="--download" falsevalue="" label="Download available OA PDFs?" value="false"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
21 <param name="max_citations" type="select" label="Max citing papers to fetch" help="Limit the number of citing papers to fetch">
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
22 <option value="10">10</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
23 <option value="20">20</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
24 <option value="50" selected="true">50</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
25 <option value="100">100</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
26 <option value="all">All</option>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
27 </param>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
28 </inputs>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
29 <outputs>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
30 <data name="summary_out" format="txt" label="Citation Summary" from_work_dir="summary.txt"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
31 <data name="tsv_out" format="tabular" label="Citing Papers TSV" from_work_dir="citing_papers.tsv"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
32 <collection name="pdf_outputs" label="Downloaded PDFs" type="list" format="pdf">
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
33 <discover_datasets pattern="__designation_and_ext__" directory="downloads"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
34 </collection>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
35 </outputs>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
36 <tests>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
37 <test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
38 <param name="input_type" value="--id"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
39 <param name="identifier" value="W4398182689"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
40 <param name="max_citations" value="10"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
41 <param name="download_pdfs" value="false"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
42 <output name="summary_out" file="expected_summary.txt"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
43 <output name="tsv_out" file="expected_citing_papers.tsv"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
44 </test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
45 <test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
46 <param name="input_type" value="--doi"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
47 <param name="identifier" value="10.1093/nar/gkae410"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
48 <param name="max_citations" value="50"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
49 <param name="download_pdfs" value="false"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
50 <output name="summary_out" file="expected_summary_doi.txt"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
51 <output name="tsv_out" file="expected_citing_papers_doi.tsv"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
52 </test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
53 <test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
54 <param name="input_type" value="--title"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
55 <param name="identifier" value="The Galaxy platform for accessible, reproducible, and collaborative data analyses: 2024 update"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
56 <param name="max_citations" value="50"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
57 <param name="download_pdfs" value="false"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
58 <output name="summary_out" file="expected_summary_title.txt"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
59 <output name="tsv_out" file="expected_citing_papers_title.tsv"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
60 </test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
61 <test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
62 <param name="input_type" value="--id"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
63 <param name="identifier" value="W2088676066"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
64 <param name="max_citations" value="10"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
65 <param name="download_pdfs" value="true"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
66 <output name="summary_out" file="expected_summary_wddownload.txt"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
67 <output name="tsv_out" file="expected_citing_papers_wddownload.tsv"/>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
68 <output_collection name="pdf_outputs" type="list" count="1">
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
69 <!-- Also working with the line below but I guess count check would be suffice -->
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
70 <!-- <element name="NAC-MYB-based transcriptional regulation of secondary cell wall biosynthesis in land plants" file="downloads/NAC-MYB-based transcriptional regulation of secondary cell wall biosynthesis in land plants.pdf"/> -->
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
71 </output_collection>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
72 </test>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
73 </tests>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
74 <help><![CDATA[
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
75 This tool fetches citing papers from OpenAlex for a paper specified by OpenAlex ID, DOI, or Title.
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
76
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
77 You can optionally download available Open Access PDFs.
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
78
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
79 **Outputs:**
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
80
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
81 - summary.txt: summary of total, OA, and closed access citing papers
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
82
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
83 - citing_papers.tsv: list of citing papers with details (title, DOI, OA)
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
84 ]]></help>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
85 <citations>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
86 <citation type="doi">10.48550/arXiv.2205.01833</citation>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
87 </citations>
1678b5f97915 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/openalex commit 7bac5b8acf6091006591be468a252e57793db4d8
iuc
parents:
diff changeset
88 </tool>