Skip to content

Commit 44f6b7c

Browse files
more documentation
1 parent 65ed461 commit 44f6b7c

1 file changed

Lines changed: 3 additions & 28 deletions

File tree

enviroMS/cli.py

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -160,37 +160,12 @@ def run_di(di_workflow_paramaters_file, jobs, replicas, tasks, mpi):
160160
@cli.command(name="run_lc_fticr")
161161
@click.argument("lc_fticr_workflow_paramaters_file", required=True, type=str)
162162
def run_lc_fticr(lc_fticr_workflow_paramaters_file):
163-
"""Run the LC FTICR MS workflow
163+
"""Run the LC FTICR MS workflow.
164164
165165
Parameters
166166
----------
167-
full_input_file_path : str
168-
The path to the toml file with the workflow parameters
169-
start_time : int
170-
The paths to the input files, separated by commas as one string
171-
end_time : int
172-
The directory where the output files will be stored
173-
time_block : int
174-
The path corems parameters toml file
175-
refmasslist_neg : str
176-
The path to the sqlite database for spectra searching
177-
output_directory : str
178-
The path to the scan translator file
179-
output_file_name : str
180-
The number of cores to use for processing
181-
output_file_type : str
182-
The number of cores to use for processing
183-
lc_fticr_toml_path : str
184-
The number of cores to use for processing
185-
corems_toml_path : str
186-
The number of cores to use for processing
187-
do_plot_van_krevelen_all_ids : bool
188-
The number of cores to use for processing
189-
do_plot_van_krevelen_individual : bool
190-
The number of cores to use for processing
191-
do_plot_properties : bool
192-
The number of cores to use for processing
193-
167+
lc_fticr_workflow_paramaters_file : str
168+
The path to the TOML file containing the workflow parameters.
194169
"""
195170

196171
run_LC_FTICR_workflow(lc_fticr_workflow_paramaters_file)

0 commit comments

Comments
 (0)