ReadMeGen: ReadMeGen

In Ilia-Kosenkov/rastrocat: R Astro Cat

Description

Generator of specific ReadMe files

Methods

Public methods

• ReadMeGen$generate_readme()

• ReadMeGen$generate_data()

• ReadMeGen$set_references()

• ReadMeGen$set_bibcode_references()

• ReadMeGen$set_keywords()

• ReadMeGen$set_adc_keywords()

• ReadMeGen$assign_data()

• ReadMeGen$assign_multiple_datasets()

• ReadMeGen$set_remarks()

• ReadMeGen$new()

• ReadMeGen$clone()

---

Method generate_readme()

Usage

ReadMeGen$generate_readme()

---

Method generate_data()

Usage

ReadMeGen$generate_data()

---

Method set_references()

Usage

ReadMeGen$set_references(...)

---

Method set_bibcode_references()

Usage

ReadMeGen$set_bibcode_references(...)

---

Method set_keywords()

Usage

ReadMeGen$set_keywords(...)

---

Method set_adc_keywords()

Usage

ReadMeGen$set_adc_keywords(...)

---

Method assign_data()

Usage

ReadMeGen$assign_data(format, data = NULL, file_name = NULL, desc = NULL)

---

Method assign_multiple_datasets()

Usage

ReadMeGen$assign_multiple_datasets(format, data)

---

Method set_remarks()

Usage

ReadMeGen$set_remarks(...)

---

Method new()

Constructor of ReadMeGen

Usage

ReadMeGen$new(cat_id, title, authors, year)

Arguments

cat_id

Mandatory id of the catalogue / project.

title

Mandatory short title.

authors

A list of authors.

year

Year of puclication.

Returns

Constructed object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ReadMeGen$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Ilia-Kosenkov/rastrocat documentation built on May 21, 2020, 4:12 a.m.