Workshop rspacer

Materials and instructions for workshops on how to use rspacer and LACDR-ISA templates.

Feel free to help us improve these materials, we are very happy with any suggestions. You can reach us by either submitting an issue or directly fix a problem using a pull request.

Introduction

This repository contains materials and instructions for workshops on how to use rspacer and LACDR-ISA templates in combination with RSpace.

At the point of writing, the workshops are step by step guides with example documents, and are meant as LACDR-specific extensions to the tutorials on the rspacer website, and instructions on the LACDR-ISA package page.

Soon, this workshop repository will be part of a nice manuscript!

Links to tutorials

• Tutorial 1
• Tutorial 2
• Tutorial 3
• Tutorial 4
• Installation instructions

Tutorial details

Tutorial 1 - using R projects

After this tutorial, you will be able to:

• Explain how an R project can make your research more reproducible
• Set up your own R project in RStudio

Tutorial 2 - using LACDR-ISA Quarto and Excel templates

After this tutorial, you will be able to:

• Explain why using templates can benefit your research
• Apply the Investigation-Study-Assay structure to your own research projects
• Use LACDR-ISA Templates in RStudio and in Excel
• Adapt the LACDR-ISA Template to your own research needs

Tutorial 3 - document from HTML

After this tutorial, you will be able to:

• Upload a rendered Quarto report as an RSpace Document using rspacer.

Tutorial 4 - document from Excel

After this tutorial, you will be able to:

• Upload information from Excel, CSV or TSV files to specific fields in an RSpace Document using rspacer.

Future tutorials to be written

Tutorial 5 - reuse data from RSpace

After this tutorial, you will be able to:

• Upload and download metadata to and from an RSpace lab journal entry using rspacer.

The functionality already exists, but we have not yet written the tutorial. For now, read the Help pages and the vignette of: rspacer::folder_tree, rspacer::document_list_attachments and rspacer::file_download.

Tutorial 6 - add attachments to an existing document

After this tutorial, you will be able to: - Upload and download metadata as attachment to an RSpace document using rspacer.

The functionality is in development. For now, use rspacer::file_upload to upload the attachments to the RSpace Gallery, and add them manually.

Tutorial 7 - append information to an assay 1.

1. Read the manuscript to see why this can be very nice to do!
2. Use rspacer::document_append_from_html to get this done.

Installation instructions {#installation-instructions}

Requirements: you need to have R Studio and R installed, and you need an account on RSpace.

1. Clone or download this git repository.
2. Go to the folder with files you just created.
3. Go to the folders and click on the Tutorial.md file or read the pdf version.