@@ -244,6 +244,87 @@ etc; for more information check
244
244
`this 3 minute read about Markdown <https://guides.github.com/features/mastering-markdown/ >`__.
245
245
246
246
247
+ I want to transfer a lot of files to Qiita, is there an easy way?
248
+ -----------------------------------------------------------------
249
+
250
+ Yes! This is available in the "Upload Files" section of each study by accessing the tab
251
+ "Upload via Remote Server (ADVANCED)".
252
+
253
+ We currently suggest using scp, note that your server where you store your files should allow
254
+ connecting to it via scp - in other words, this only works when moving files from a server to Qiita.
255
+
256
+ Now, the way it works is that you need to create a new secure key to that server, imagine
257
+ that you are making a copy of your storage-shed key, then you share that key to Qiita (you will give
258
+ access to Qiita to run a single copy command in your server), Qiita uses that key and securely
259
+ destroy it.
260
+
261
+ To take advantage of this feature you need to:
262
+ 1. Prepare all the files you want to transfer in a single folder (or you can do this on
263
+ multiple folders). Note that Qiita will only collect files with valid extensions; see the
264
+ top of the "Upload Files" page within your study for the latests list of valid extensions.
265
+ 2. In your server (this needs to be run within your home directory in the server where you
266
+ store the files!), generate a new key by running:
267
+ `ssh-keygen -t rsa -C "ssh test key" -f ~/.ssh/qiita-key -P "" `. Here is where you are
268
+ creating that key to your storage-shed.
269
+ 3. Allow access using the new key to new connections (this also needs to be ran in the
270
+ remote server): `cat ~/.ssh/qiita-key.pub >> ~/.ssh/authorized_keys `. This tells the
271
+ server that is OK to give access to the key created to your storage-shed; note that if
272
+ you want to completely stop that key to work you can open that file and remove the line
273
+ with the name of this key.
274
+ 4. Dowload your new generated key `qiita-key ` (the file) to your local computer and use it
275
+ in the `Key ` option of "Upload via Remote Server (ADVANCED)".
276
+
277
+ Using this key you can `List Files ` to test the connection and verify the list of study files. Then,
278
+ if the connection is made and files are correct, press 'Transfer Files' to initiate the transfer.
279
+
280
+ Note that if you click multiple times, too quickly there is a chance that your server will block
281
+ Qiita, if this happens, just wait a few minutes and retry again.
282
+
283
+
284
+ How do I update the sample or preparation file?
285
+ -----------------------------------------------
286
+
287
+ Remember, these are separate files so they need to be updated separately. In both cases,
288
+ the easiest is to upload the new file from your computer to Qiita using the `Upload Files `
289
+ button in your study. Once the file you want to use is there you can use them within Qiita.
290
+
291
+ To update a sample information file: Click on `Sample Information ` button in the your study
292
+ page, then use the `Update sample information ` section on that page to select your file and
293
+ update it. Note that for this you can also directly upload your file via the
294
+ `Direct upload file (< 2MB) `.
295
+
296
+ To update a preparation information file: Click on the preparation you want to update within
297
+ your study page, then click on `Summary `, and use the `Update prep information ` section on
298
+ that page to select your file and update it.
299
+
300
+ Note that these information is generally independent of the sequence processing so you
301
+ don't need to reprocess your sequences; however, if you use your study in an analysis, you will
302
+ need to recreate that analysis to use the updated sample or preparation metadata
303
+
304
+
305
+ When do I need the run_prefix in my preparation information file?
306
+ -----------------------------------------------------------------
307
+
308
+ It depends on your sequence processing but in general it will facilitate loading your
309
+ files to your preparation in Qiita.
310
+
311
+ First of all, this is a prefix value so you only need the beginning of the file
312
+ name to load the files in Qiita; for example if your file names for a given sample are:
313
+ AWERWADFA_I1.fastq.gz, AWERWADFA_R1.fastq.gz, AWERWADFA_R2.fastq.gz, the run_prefix for
314
+ the sample should be AWERWADFA. Qiita will use that to group those files under the same
315
+ sample with that run_prefix.
316
+
317
+ Now the run_prefix is used constantly within file selection and processing in all file types but
318
+ specially on:
319
+ - BIOM: the run_prefix is used to rename the samples in your BIOM to match the sample names
320
+ in Qiita. Basically, if you add the sample names in your BIOM file as the run_prefix and the
321
+ sample name in Qiita in the sample_name column of your preparation, Qiita will automatically
322
+ rename them to match.
323
+ - per sample FASTQ: run_prefix is the way to link which sample goes with which files so using here
324
+ will facilitate loading your files to the preparation and then used for processing, without it
325
+ Qiita will not be able to process your samples.
326
+
327
+
247
328
How to cite Qiita?
248
329
------------------
249
330
0 commit comments